Project structure

This section provides an overview of the directory and file structure of the project. Each subsection describes the purpose and contents of specific directories and files, highlighting their roles within the overall architecture. Understanding this structure is crucial for effective development, maintenance, and deployment of the application. Below is a detailed explanation of each component in the project.

Table of contents

1. .github/workflows
2. app
3. core
4. docker
   1. entrypoints
   2. development_entrypoints.sh
   3. production_entrypoints.sh
   4. render_entrypoints.sh
   5. images
      1. Dockerfile.dev
      2. Dockerfile.locust
      3. Dockerfile.mariadb
      4. Dockerfile.prod
      5. Dockerfile.render
   6. letsencrypt
   7. nginx
   8. public
   9. docker-compose.dev.yml
   10. docker-compose.prod.ssl.yml
   11. docker-compose.prod.yml
5. vagrant
   1. Vagrantfile
   2. *.yml
6. migrations
7. rosemary
8. scripts
9. .env.<deployment_environment>.example
10. .flake8
11. .gitignore
12. requirements.txt
13. setup.py

.github/workflows

This directory contains GitHub Actions workflows. These YAML files define automated actions that run on specific repository events, such as pushes or pull requests.

app

This directory likely contains the main application code. It includes modules, views, controllers, and other fundamental components of the application’s business logic.

core

This directory usually contains core components and services used throughout the application. It can include utilities, global configurations, and base classes.

docker

entrypoints

development_entrypoints.sh

Entrypoint script that is launched when running the web app container in development environment.

production_entrypoints.sh

Entrypoint script that is launched when running the web app container in production environment.

render_entrypoints.sh

Entrypoint script that is launched when running the web app container in Render environment.

images

Dockerfile.dev

Docker file for building the application’s development image. It includes all dependencies and configurations needed for a development environment.

Dockerfile.locust

Docker file for running load and stress tests using Locust package

Dockerfile.mariadb

Docker file for building a MariaDB image, a SQL database. It is used to integrate the database into the development or production environment.

Dockerfile.prod

Docker file for building the application’s production image. It is optimized for performance and security.

Dockerfile.render

Docker file for deploying the application on Render.com service

letsencrypt

This directory is related to Let’s Encrypt, a free certificate authority. It contains scripts and configurations for the automatic generation of SSL certificates.

nginx

This directory contains configurations for the NGINX web server, which is used to serve the application, handle HTTP traffic, and perform other network-related tasks.

public

This directory is for generating SSL certificates, it acts as a temporary public folder.

docker-compose.dev.yml

Docker Compose configuration file for the development environment. It defines how development containers should be orchestrated.

docker-compose.prod.ssl.yml

Docker Compose configuration file for the production environment (with SSL). It defines how containers should be orchestrated in production.

docker-compose.prod.yml

Docker Compose configuration file for the production environment. It defines how containers should be orchestrated in production.

vagrant

Vagrantfile

This file is a specification that describes how to create a virtual machine (VM) under specific characteristics. It defines the necessary configurations for the development environment, such as the base box, network, shared folders, and provisioning scripts.

*.yml

These files, known as playbooks, are used by Ansible to automate system configuration and management. A playbook is a YAML file that contains a series of instructions and tasks that Ansible will execute on the target machines. Playbooks are used to automate complex and repetitive tasks, ensuring that the development or production environment is configured in a consistent manner.

migrations

This directory contains database migration files, which allow incremental changes to the database schema in a controlled and reproducible manner.

rosemary

This directory contains the code for the Rosemary CLI package. It is a version still under development and is not available in pypi at the moment.

scripts

Contains auxiliary scripts that automate various tasks such as dependency installation, deployment, maintenance, and more.

.env.<deployment_environment>.example

These files provide an example of the environment variables needed to run the application. They are used as a reference for setting up the development environment.

.flake8

Contains configurations for Flake8, a code style and checking tool for Python. It helps maintain code consistency and find common errors.

.gitignore

A list of files and directories that Git should ignore. This prevents certain files (like local configurations and temporary files) from being included in version control.

requirements.txt

A list of Python dependencies needed for the project. Used by pip to install all required libraries.

setup.py

A setup script used for distributing Python packages. It defines package properties such as name, version, and dependencies. In this case, it is used to use the rosemary package.