docs: remove project structure, boring and hard to maintain
This commit is contained in:
38
README.md
38
README.md
@@ -354,44 +354,6 @@ It will start the application in development mode. You can also run it as a daem
|
|||||||
|
|
||||||
Then, use `./bin/goyco` to manage the application and notably to seed the database with sample data.
|
Then, use `./bin/goyco` to manage the application and notably to seed the database with sample data.
|
||||||
|
|
||||||
### Project Structure
|
|
||||||
|
|
||||||
```bash
|
|
||||||
goyco/
|
|
||||||
├── bin/ # Compiled binaries (created after build)
|
|
||||||
├── cmd/
|
|
||||||
│ └── goyco/ # Main CLI application entrypoint
|
|
||||||
├── docker/ # Docker Compose & related files
|
|
||||||
├── docs/ # Documentation and API specs
|
|
||||||
├── internal/
|
|
||||||
│ ├── config/ # Configuration management
|
|
||||||
│ ├── database/ # Database models and access
|
|
||||||
│ ├── dto/ # Data Transfer Objects (DTOs)
|
|
||||||
│ ├── e2e/ # End-to-end tests
|
|
||||||
│ ├── fuzz/ # Fuzz tests
|
|
||||||
│ ├── handlers/ # HTTP handlers
|
|
||||||
│ ├── integration/ # Integration tests
|
|
||||||
│ ├── middleware/ # HTTP middleware
|
|
||||||
│ ├── repositories/ # Data access layer
|
|
||||||
│ ├── security/ # Security and auth logic
|
|
||||||
│ ├── server/ # HTTP server implementation
|
|
||||||
│ ├── services/ # Business logic
|
|
||||||
│ ├── static/ # Static web assets
|
|
||||||
│ ├── templates/ # HTML templates
|
|
||||||
│ ├── testutils/ # Test helpers/utilities
|
|
||||||
│ ├── validation/ # Input validation
|
|
||||||
│ └── version/ # Version information
|
|
||||||
├── scripts/ # Utility/maintenance scripts
|
|
||||||
├── services/
|
|
||||||
│ └── goyco.service # Systemd service unit example
|
|
||||||
├── .env.example # Environment variable example
|
|
||||||
├── AUTHORS # Authors file
|
|
||||||
├── Dockerfile # Docker build file
|
|
||||||
├── LICENSE # License file
|
|
||||||
├── Makefile # Project build/test targets
|
|
||||||
└── README.md # This file
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user