🗂️ Folder structure for Prefix¶
DataEngineer
.
|-- docs/ # General documentation: guides, notes, functional explanations, tips.
| | CHANGELOG.md # Versioned log of notable changes.
| | LICENSE # Project license (MIT, Apache 2.0, etc.).
| | software-development-another-tool.md # Internal documentation about another development tool.
| | software-development-vscode-tool.md # Notes, tips, and configurations related to VSCode.
| | troubleshooting-logging.md # Troubleshooting and logging guide for diagnosing issues.
|-- DataEngineer/ # Database domain management: schema, seeds, queries, utilities.
| | migrations/ # Scheme changes
| | | backup.sh # Backup script console or SQL
| | | restore.sh # Restore script console or SQL
| | seeds/ # Initial data
| | | init-db.sh # Script to load baseline seed data
| | scripts/ # Loose SQL, maintenance, utilities
|-- Ops/ # Infrastructure and operational environment (DevOps).
| | docker/ # Docker setup, configuration, and environment files.
| | | docs/ # Docker Installation/Upgrade Guides
| | | docker-compose.yml # Main Docker Compose configuration file
|-- README.md # Project documentation, configuration instructions and references to additional documentation in the `docs/` folder..
🗂️ Folder structure for applications¶
.
|-- app/ # API main folder.
| |-- common/ # Common Layer class library.
| | |-- constants.py # Definition of global variables.
| | |-- messages.py # System messages to be used by all methods.
| |-- core/ # Definition of base configurations.
| | |-- config.py # Defining environment variables as loading environment variables.
| |-- routers/ # The path operations related to your users separated from the rest of the code, to keep it organized.
| | |-- default.py # Method for response 200 to request without action to do.
| | |-- health.py # Methods to monitor health behavior.
| | |-- redis.py # Methods to monitor redis.
| | |-- task.py # Methods to crud tasks.
| |-- services/ # Controller Layer / Business logic (including CRUD helpers).
| | |-- health.py # Health rules.
| | |-- redis.py # Methods to monitor redis.
| | |-- task.py # Methods to crud tasks.
|-- docs/ # Internal documentation of the microservice.
|-- main.py # Startup code for the API.
|-- entrypoint.sh # Defining the executable that the container will use.
|-- requirements.txt # Defining required Python packages.
|-- .env # Environment variables that must be created based on `.env.sample`.
|-- .env.sample # Environment Variables without keys or password.
|-- Dockerfile # Instructions to build container.
|-- README.md # Internal documentation of the microservice, environment variables, implementation and specific functionalities.
🗂️ Folder structure for docs¶
docs/
├─ README.md
│
├─ overview/
│ └─ architecture.md
│
├─ guides/
│ ├─ docker-and-semantic-versioning.md
│ ├─ getting-started/
│ │ └─ os-package-managers.md
│ └─ software-development/
│ ├─ vscode.md
│ └─ another-tool.md
│
├─ troubleshooting/
│ └─ logging.md
│
├─ governance/
│ ├─ license.md
│ └─ contributing.md
│
├─ files/
│ └─ architecture.pdf
│ └─ architecture.drawio