FasthapiX

Table of contents

• Stack
• Prerequisites
• Setup
• IDE configuration
• Tests
• CI/CD

Stack

         

              

         

Python project pyproject. Temporary use of tailwindcss and alpine.js from cdn.

TODO db (postgres), docker, nginx

Prerequisites

Install Python package and project manager: UV

Install just a command runner (make inspiration): just

Setup

Install all dependencies:

just install

Launch local server (TODO):

just project-run

List of tasks:

just --list

Add package

uv add package-name

adds dependency package, while

uv add --dev package-name

adds development dependency package. Both updates pyproject.toml and uv.lock

uv add --group groupname package-name

See groups in pyproject.toml.

Architecture

Description of the project's architecture. Diagrams, maps, etc.

TODO

API trying to respect this

IDE configuration

vscode workspace file is present.

Tests

Obviously:

just check-test

CI/CD

Description of what the CI/CD process looks like and how it works. What is the deployment strategy, etc.

TODO

https://pre-commit.com/

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.