diff --git a/readme.md b/readme.md index a2f9e0a..41e9848 100644 --- a/readme.md +++ b/readme.md @@ -190,6 +190,7 @@ Gitea Actions CI/CD Authentication is based on a personal access code assigned to each guest. +``` Guest │ │ 6-digit code @@ -206,6 +207,7 @@ POST /api/auth │ ▼ Authenticated +``` The JWT is stored in a cookie and used for subsequent API requests. @@ -277,7 +279,7 @@ The table contains: * administrator privileges. The database layer uses an asynchronous stack: - +``` FastAPI │ ▼ @@ -288,7 +290,7 @@ aiosqlite │ ▼ SQLite - +``` Database schema changes are managed using Alembic. ⸻ @@ -340,7 +342,7 @@ pip install -r requirements.txt 4. Environment Variables Create a .env file in the project root. - +``` Example: DIR=/path/to/project @@ -348,7 +350,7 @@ PORT=8000 SECRET_KEY=change-me ALGORITHM=HS256 ACCESS_TOKEN_EXPIRE_SECONDS=3600 - +``` You can use env_example as a reference when configuring the environment. ⚠️ Never commit a real SECRET_KEY to Git. @@ -455,7 +457,7 @@ make help 🔄 CI/CD The project uses Gitea Actions for automation. - +``` The general workflow: git push @@ -477,13 +479,13 @@ The general workflow: │ ▼ Production - +``` The workflow builds the Docker image and performs deployment to the target environment. ⸻ 🌐 Production - +``` The production infrastructure consists of: Internet @@ -497,7 +499,7 @@ Internet │ ▼ SQLite - +``` Caddy acts as a reverse proxy and handles external HTTP/HTTPS traffic. Ansible is used to automate deployment and server configuration. @@ -534,7 +536,7 @@ JavaScript is responsible for: ⸻ 🧪 Development - +``` Recommended development workflow: Feature branch @@ -556,7 +558,7 @@ Build │ ▼ Deploy - +``` Before pushing changes, it is recommended to run: python -m compileall . @@ -600,7 +602,7 @@ Possible future improvements: ⸻ 📊 Project - +``` Main languages used in the project: HTML ████████████████████ 40.5% @@ -610,7 +612,7 @@ JavaScript ████ 7.6% Makefile ▏ 0.7% The statistics are based on the current state of the repository. - +``` ⸻ 📄 License