docs: add screenshot to README
This commit is contained in:
parent
075939142f
commit
c48a1684e9
2 changed files with 7 additions and 5 deletions
12
README.md
12
README.md
|
|
@ -2,7 +2,9 @@
|
|||
|
||||
Backend for orchestrating deployment of censorship circumvention resources.
|
||||
|
||||
## 🪓 Local Development
|
||||

|
||||
|
||||
## Local Development
|
||||
|
||||
### Setup just
|
||||
MacOS:
|
||||
|
|
@ -42,7 +44,7 @@ With extra configs (e.g. logging file)
|
|||
just run --log-config logging.ini
|
||||
```
|
||||
|
||||
### 🔍 Linters
|
||||
### Linters
|
||||
Format the code with `ruff --fix` and `ruff format`
|
||||
```shell
|
||||
just lint
|
||||
|
|
@ -62,7 +64,7 @@ just migrate
|
|||
just downgrade downgrade -1 # or -2 or base or hash of the migration
|
||||
```
|
||||
|
||||
## 🏃🏻♀️➡️ Deployment
|
||||
## Deployment
|
||||
Deployment is done with Docker and Gunicorn. The Dockerfile is optimized for small size and fast builds with a non-root user. The gunicorn configuration is set to use the number of workers based on the number of CPU cores.
|
||||
|
||||
Example of running the app with docker compose:
|
||||
|
|
@ -70,7 +72,7 @@ Example of running the app with docker compose:
|
|||
docker compose -f docker-compose.prod.yml up -d --build
|
||||
```
|
||||
|
||||
## 📜 Conventions
|
||||
## Conventions
|
||||
|
||||
This project uses the
|
||||
[FastAPI best practices](https://github.com/zhanymkanov/fastapi-best-practices)
|
||||
|
|
@ -78,7 +80,7 @@ documented by GitHub user zhanymkanov and was originally created from their
|
|||
[template](https://github.com/zhanymkanov/fastapi_production_template).
|
||||
|
||||
|
||||
## 🖋️ Copyright
|
||||
## Copyright
|
||||
|
||||
Copyright © 2025 SR2 Communications Limited.
|
||||
|
||||
|
|
|
|||
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 553 KiB |
Loading…
Add table
Add a link
Reference in a new issue