Did you know that GitHub supports table of contents by default 🤔

This is the FastAPI ASGI application.

• Python 3.12 & Poetry
• FastAPI
• Database and ORM: MongoDB & Beanie
• Formatting and linting: Ruff, pre-commit
• Deployment: Docker, Docker Compose, GitHub Actions

1. Install Python 3.12+, Poetry, Docker
2. Install project dependencies with Poetry.

   poetry install

3. Start development server:

   poetry run python -m src.api --reload

   Follow provided instructions if needed

4. Open in the browser: http://localhost:8000

   The api will be reloaded when you edit the code

Set up PyCharm integrations

1. Run configurations (docs). Right-click the __main__.py file in the project explorer, select Run '__main__' from the context menu.
2. Ruff (plugin). It will lint and format your code. Make sure to enable Use ruff format option in plugin settings.
3. Pydantic (plugin). It will fix PyCharm issues with type-hinting.
4. Conventional commits (plugin). It will help you to write conventional commits.

We use Docker with Docker Compose plugin to run the service on servers.

1. Copy the file with environment variables: cp .example.env .env
2. Change environment variables in the .env file
3. Copy the file with settings: cp settings.example.yaml settings.yaml
4. Change settings in the settings.yaml file according to your needs (check settings.schema.yaml for more info)
5. Install Docker with Docker Compose
6. Build a Docker image: docker compose build --pull
7. Run the container: docker compose up --detach
8. Check the logs: docker compose logs -f

1. Run poetry update to update all dependencies (it may update nothing, so double-check)
2. Run poetry show --outdated --all to check for outdated dependencies
3. Run poetry add <package>@latest to add a new dependency if needed

1. Run poetry run pre-commit autoupdate

Also, Dependabot will help you to keep your dependencies up-to-date, see dependabot.yml.