clean_mss_template 🌡🍽

Template for Backend Challenges

The Project 📽

Introduction and Objectives ⁉

The main objective is to provide a template for repositories that can be used as a starting point for new backend challenges.

Reasons 1️⃣3️⃣

The project aims to help developers to start challenges, so that anybody can enhance their programming skills.

Folder Structure 🎄🌴🌲🌳

Our folder structure was developed specially for our projects.

.
├── iac
├── src
│   ├── modules
│   │   ├── create_user
│   │   │   └── app
│   │   ├── delete_user
│   │   │   └── app
│   │   ├── get_user
│   │   │   └── app
│   │   └── update_user
│   │       └── app
│   └── shared
│       ├── domain
│       │   ├── entities
│       │   ├── enums
│       │   └── repositories
│       ├── helpers
│       │   ├── enum
│       │   ├── errors
│       │   ├── functions
│       │   └── http
│       └── infra
│           ├── dto
│           ├── external
│           └── repositories
└── tests
    ├── modules
    │   ├── create_user
    │   │   └── app
    │   ├── delete_user
    │   │   └── app
    │   ├── get_user
    │   │   └── app
    │   └── update_user
    │       └── app
    └── shared
        ├── domain
        │   └── entities
        ├── helpers
        └── infra

Name Format 📛

Files and Directories 📁

• Files have the same name as the classes
• snake_case 🐍 (ex: ./app/create_user_controller.py)

Classes 🕴

• Pattern 📟

  • CamelCase 🐫🐪

• Types 🧭

  • Interface starts with "I" --> IUserRepository, ISelfieRepository 😀
  • Repository have the same name as interface, without the "I" and the type in final (ex: UserRepositoryMock, SelfieRepositoryDynamo) 🥬

Methods 👨‍🏫

• snake_case 🐍
• Try associate with a verb (ex: create_user, get_user, update_selfie)

Variables 🅰

• snake_case 🐍
• Avoid verbs

Enums

• SNAKE_CASE 🐍
• File name ends with "ENUM" (ex: "STATE_ENUM")

Tests 📄

• snake_case 🐍
• "test" follow by class name (ex: test_cadastrar_usuario_valido, test_cadastrar_usuario_sem_email)
  • The files must start with "test" to pytest recognition

Commit 💢

• Start with verb
• Ends with emoji 😎

Architecture Diagram 🏗

Installation 👩‍💻

Clone the repository using template

Create virtual ambient in python (only first time)

Windows

python -m venv venv

Linux

virtualenv -p python3.9 venv

Activate the venv

Windows:

venv\Scripts\activate

Linux:

source venv/bin/activate

Install the requirements

pip install -r requirements-dev.txt

Run the tests

pytest

To run local set .env file

STAGE = TEST

Contributors 💰🤝💰

• Bruno Vilardi - Brvilardi 👷‍♂️
• Hector Guerrini - hectorguerrini 🧙‍♂️
• João Branco - JoaoVitorBranco 😎
• Vitor Soller - VgsStudio ☀
• Lucas Duez - Lucasdvs10 🤡
• Rodrigo Morales - RodrigoM2004 🚗
• Lucas Milani - LucasKiller 🔪
• Rafael Rubio - Rubiozito 🎸

Special Thanks 🙏

• Dev. Community Mauá
• Institute Mauá of Technology