Skip to content

DizzyZ7/worknest-api

Repository files navigation

WorkNest API

Production-ready FastAPI service with incidents module, PostgreSQL-ready database wiring, Docker support, and a single canonical launch path.

Stack

  • FastAPI
  • SQLAlchemy
  • PostgreSQL
  • Alembic
  • Docker / Docker Compose
  • Pytest

Project run (local)

pip install -r requirements.txt
uvicorn app.main:app --reload

Project run (production-like)

docker-compose -f docker-compose.prod.yml up --build

API

  • GET /health
  • GET /api/v1/info
  • GET /api/v1/incidents
  • POST /api/v1/incidents

Environment

Main environment variable:

  • DATABASE_URL

Example for docker compose:

DATABASE_URL=postgresql://worknest:worknest@db:5432/worknest

Notes

  • app/main.py is the only application entrypoint.
  • requirements.txt is the only dependency file.
  • README.md is the only project readme.

About

REST API for collaborative workspace and task management built with FastAPI, PostgreSQL, Docker, and JWT authentication.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors