Table of contents

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

About

This is the API for viewing maps in InNoHassle.

Technologies

• Python 3.14 & uv
• FastAPI
• Formatting and linting: Ruff, pre-commit
• Deployment: Docker, Docker Compose, GitHub Actions

Development

Set up for development

1. Install uv and Docker
2. Install dependencies:
3. Start development server (and read logs in the terminal):

   uv run -m src.api --reload

   Follow the 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.

Deployment

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. Run the containers: docker compose up --build --wait
7. Check the logs: docker compose logs -f

FAQ

Be up to date with the template!

Check https://github.com/one-zero-eight/fastapi-template for updates once in a while.

How to update dependencies

1. Run uv sync --upgrade to update uv.lock file and install the latest versions of the dependencies.
2. Run uv tree --outdated --depth=1 will show what package versions are installed and what are the latest versions.
3. Run uv run prek auto-update

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

Contributing

We are open to contributions of any kind. You can help us with code, bugs, design, documentation, media, new ideas, etc. If you are interested in contributing, please read our contribution guide.