Skip to content

README.md

Latest commit

 

History

History
71 lines (50 loc) · 1.86 KB

README.md

File metadata and controls

71 lines (50 loc) · 1.86 KB
Raw

TODO App

A minimal TODO list application built on the Towlion platform.

Getting Started

  1. Click "Use this template" on GitHub to create a new repository
  2. Clone your new repo and configure environment variables
  3. Build and deploy

Project Structure

app/                    # FastAPI backend
  main.py               # Application entry point
  Dockerfile            # Backend container image
  models.py             # SQLAlchemy models
  tasks.py              # Celery background tasks
  alembic/              # Database migrations
deploy/
  docker-compose.yml    # App containers (multi-app mode)
  docker-compose.standalone.yml  # Full stack (self-hosted)
  Caddyfile             # Reverse proxy config
  env.template          # Environment variable reference
frontend/               # Optional Next.js frontend
scripts/
  health-check.sh       # Deployment health check

Local Development

# Install dependencies
pip install -r requirements.txt

# Run the app
uvicorn app.main:app --reload --port 8000

# Verify it works
curl http://localhost:8000/health

Environment Variables

Copy deploy/env.template to deploy/.env and fill in your values. See the platform spec for details on required and optional variables.

Deployment

Multi-app mode (managed server)

Push to main to trigger the deploy workflow. The GitHub Action SSHs into the server and runs:

docker compose -f deploy/docker-compose.yml up -d --build

Self-hosting (fork mode)

For standalone deployment on a single server:

cp deploy/env.template deploy/.env
# Edit deploy/.env with your values
docker compose -f deploy/docker-compose.standalone.yml up -d

This includes PostgreSQL, Redis, MinIO, and Caddy alongside your app.

License

MIT