mirror of
https://github.com/KeyZox71/knl_meowscendence.git
synced 2025-08-14 04:22:54 +02:00
「📝」 doc(README): added folder structure
This commit is contained in:
14
README.md
14
README.md
@ -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
|
||||
|
Reference in New Issue
Block a user