supportdesk-api

FastAPI + Postgres service (portfolio) powering SupportDesk UIs like supportdesk-admin-ui repo.

Quickstart

Run Locally

docker compose up --build

API: http://localhost:8080/docs

Run via Codespaces

This repo ships a .devcontainer that uses the existing docker-compose.yml:

• DB and API start automatically
• Port 8080 is forwarded

Open the repo in Codespaces, then hit: http://localhost:8080/docs

How to test

python -m pytest

Project structure

For the full directory map and “what goes where” conventions, see STRUCTURE.md.

• app/ – FastAPI app
• app/routes/ – endpoints
• tests/ – API tests
• docker-compose.yml – local DB + API
• docs/ – longer-form documentation (architecture, API, etc)

Documentation

See documentation

Contributing

See the contributing guidelines

• Roadmap: ROADMAP.md

Security

See the security policy

License

See LICENSE