jasima/pali-lili
3
0
Fork 0
Code Issues 10 Pull requests Projects Releases Packages Wiki Activity Actions

docs: add screenshot to README

Browse source
This commit is contained in:
Iain Learmonth 2025-12-14 17:55:13 +00:00
parent 075939142f
commit c48a1684e9
2 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -2,7 +2,9 @@
Backend for orchestrating deployment of censorship circumvention resources. Backend for orchestrating deployment of censorship circumvention resources.
## 🪓 Local Development ![](./screenshot.png)
## Local Development
### Setup just ### Setup just
MacOS: MacOS:
@ -42,7 +44,7 @@ With extra configs (e.g. logging file)
just run --log-config logging.ini just run --log-config logging.ini
``` ```
### 🔍 Linters ### Linters
Format the code with `ruff --fix` and `ruff format` Format the code with `ruff --fix` and `ruff format`
```shell ```shell
just lint just lint
@ -62,7 +64,7 @@ just migrate
just downgrade downgrade -1 # or -2 or base or hash of the migration 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. 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: 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 docker compose -f docker-compose.prod.yml up -d --build
``` ```
## 📜 Conventions ## Conventions
This project uses the This project uses the
[FastAPI best practices](https://github.com/zhanymkanov/fastapi-best-practices) [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). [template](https://github.com/zhanymkanov/fastapi_production_template).
## 🖋️ Copyright ## Copyright
Copyright © 2025 SR2 Communications Limited. Copyright © 2025 SR2 Communications Limited.

BIN
screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 553 KiB