Starting a Project

This document explains how to start a new service or module project.

Prerequisites

You will need the following tools:

• Cookiecutter
• Docker

Background Knowledge

Clean Architecture

Clean architecture is a software architecture proposed by Robert C. Martin, also known as Uncle Bob. It defines the layers responsible for different parts of the software and the dependency rules between them, minimizing dependencies across layers. For example, you can change the presentation layer without changing the business logic, and vice versa. With fewer dependencies between layers, it is easier to change data stores, and changes to domain logic are less affected by the framework. For more detail, see The Clean Architecture.

Package by Feature

Packages play an important role in keeping code that is used or changed together in one place (high cohesion), while separating unrelated or independent code (loose coupling). Package syntax and usage vary by language, but the purpose and principles are largely the same.

Two common approaches are package by layer and package by feature. Packaging by layer is relatively easy to understand, but makes it harder to achieve high cohesion and loose coupling. Changing a single feature can require edits across several packages and a lot of navigation between them. Packaging by feature, on the other hand, offers clear advantages in fulfilling the purpose of packages and is widely used.