Quick Start

This guide helps you get the Cats API up and running quickly.

Local Development

1. Ensure Installation: Complete the Installation steps.

2. Start the Infrastructure: Launch the database container:

just infra

1. Run the Server: Start the FastAPI application:

just serve

1. Access the API:
2. Swagger UI: http://localhost:8080/docs
3. Healthcheck: http://localhost:8080/v1/healthcheck/

Full Docker Stack

To run all services (API, database, Grafana, Loki, etc.):

just up

• API: http://localhost:80/api
• Grafana: http://localhost/grafana (default credentials: admin/admin)

Running Tests

Execute integration tests with coverage:

just cov