📝」 doc(README): added folder structure

This commit is contained in:
2025-07-26 10:50:28 +02:00
parent 8973f67ad4
commit fbd8be1ea1

View File

@ -1,6 +1,20 @@
# knl_meowscendence
Press F to pay respect
## Folder structure
├── docker/ # Docker-related setup for services
│ ├── api-base/ # Backend API base image and compose file
│ ├── front/ # Frontend image, config, and cert automation
│ ├── monitoring/ # Monitoring stack: Prometheus, Grafana, exporters
│ ├── networks.yml # Docker network definitions
│ └── volumes.yml # Docker volume definitions
├── src/ # Application source code
│ ├── api/ # Backend logic (auth, user management)
│ ├── front/ # Frontend files
│ └── utils/ # Utility modules (auth, TOTP, etc.)
├── flake.nix & flake.lock # Nix flake configuration
└── Justfile # Task automation commands
## Modules done
5 major + 2 minor = 6 full modules