diff --git a/7project/src/README.md b/7project/src/README.md index e69de29..0ddd934 100644 --- a/7project/src/README.md +++ b/7project/src/README.md @@ -0,0 +1,23 @@ +## Folder structure + +- `src/` + - `backend/` + - `alembic/` - database migrations + - `app/` - main application code + - `tests/` - tests + - `docker-compose.test.yml` - docker compose for testing database + - `Dockerfile` - production Dockerfile + - `main.py` - App entrypoint + - `requirements.txt` - Python dependencies + - `test_locally.sh` - script to run tests with temporary database + - `charts/` + - `myapp-chart/` - Helm chart for deploying the application, supports prod and dev environments + - `frontend/` - React frontend application + - `tofu/` - Terraform/OpenTofu services deployment configurations + - `modules/` - separated modules for different services + - `main.tf` - main deployment configuration + - `variables.tf` - deployment variables + - `terraform.tfvars.example` - example variables file + - `compose.yaml` - Docker Compose file for local development + - `create_migration.sh` - script to create new Alembic database migration + - `upgrade_database.sh` - script to upgrade database to latest Alembic revision \ No newline at end of file