Monochrome
Monochrome's API, implemented with Deta Base and Deta Drive.
Create a free account on Deta to test this out!
Most users will prefer the Monochrome full stack, which contains the API, the frontend and the backend.
Usage
Docker
This service is available on ghcr.io:
docker pull ghcr.io/monochromecms/monochrome-api-deta:latest
The database needs to be set up, and an admin user created:
docker run \
-e DETA_PROJECT_KEY=... \
ghcr.io/monochromecms/monochrome-api-deta:latest \
create_admin
Once done, the image can be launched with the required env. vars:
docker run -p 3000:3000 \
-e DETA_PROJECT_KEY=... \
-e JWT_SECRET_KEY=changeMe \
ghcr.io/monochromecms/monochrome-api-deta:latest
The images are stored on Deta Drive, they are available on the /media route or on the Deta Web UI.
Makefile
A Makefile is provided with this repository, to simplify the development and usage:
help Show this help message
up start Run a container from the image, or start it natively
# Docker utils
build Build image
logs Read the container's logs
sh Open a shell in the running container
# Dev utils
lock Refresh pipfile.lock
lint Lint project code
format Format project code
# Main utils
secret Generate a secret
create_admin Create a new admin user
# Tests
test Run the tests
So the basic usage would be:
make create_admin
make start
.env
While using the Makefile, the image settings can be set with a .env file, see .env.example.
Native
Even though Docker is the recommended method, some Makefile rules are native compatible, so a virtual environment can also be used after cloning this repository:
#You need to be able to run these commands on your terminal:
tar, 7z, unrar, xz
pip install pipenv
pipenv shell
pipenv install
make native=1 install
Environment variables
# Deta project key, more info on https://deta.sh
DETA_PROJECT_KEY
# Comma-separated list of origins to allow for CORS, namely the origin of your frontend
CORS_ORIGINS = ""
# Secret used to sign the JWT
JWT_SECRET_KEY
# Algorithm used to sign the JWT
JWT_ALGORITHM = "HS256"
# Amount of minutes a JWT will be valid for
JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 60
# Path where temporary data will be stored (DON'T CHANGE THIS IN DETA MICROS)
TEMP_PATH = "/tmp"
# For pagination, the maximum of elements per request, has to be positive
MAX_PAGE_LIMIT = 50
# Allows anyone to create a "user" account
ALLOW_REGISTRATION=False
Roles
Each used can have one of different roles, this is done to have a sort of hierarchy:
Admin
The role the create-admin command gives to the user, it's the highest role and grants all the permissions (user and website management, upload and editing of manga and chapters)
Uploader
This role can create new manga and upload new chapters, but can only edit/delete those that they have created themselves.
User
This user can only update its own user for now, it'll become more useful once other features are added to Monochrome (comments, notifications, reading progress...) You can already allow registrations via the respective env var, but it isn't recommended until meaningful features are added.
Tools used
- FastAPI
- Deta Base
- Deta Drive
- Pydantic
Progress
- Creation
🟢 100% (new features can always be added) - Documentation
🟡 58% - OpenAPI
🟡 66% - Cleaner code
🟡 50% - Testing
🟠 40% (I still need to use this implementation throughly)- Unit
🟢 100% - Integration
🔴 10%
- Unit
Credits:
- Base API template: https://github.com/grillazz/fastapi-sqlalchemy-asyncpg
- Deta documentation: https://docs.deta.sh
3 Dec 10, 2022
25 May 31, 2022
2 Jul 11, 2022
1 Dec 17, 2021
47 Dec 19, 2022
1 Jan 3, 2022
9 Mar 12, 2022
5 Dec 16, 2022
4 Nov 9, 2022
70 Dec 20, 2022
74 Sep 13, 2022
2 Dec 25, 2021
827 Jan 04, 2023
5 Nov 20, 2022
1 Jan 02, 2022
16 Jun 17, 2022
1 Dec 25, 2021
4 May 31, 2022
1 Feb 09, 2022
3 Apr 23, 2022
121 Nov 15, 2022
0 Jan 28, 2022
2 Dec 19, 2021
12 Sep 02, 2022
2 May 17, 2022
144 Dec 27, 2022
3 Jan 04, 2022
19 Dec 15, 2022
7 Dec 20, 2022