MH.Dmitrii/wedding-site
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix readme
Build Docker / deploy (push) Has been cancelled
Details
Build Docker / build (push) Has been cancelled
Details

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