This quickstart guide provides a high-level overview. See the full documentation for comprehensive information on features, installation, architecture, conventions, code style, and customization, deployment to cloud platforms, and contributing.
This template combines three of the most lightweight and performant open-source web development frameworks into a customizable webapp template with:
- Pure Python backend
- Minimal-Javascript frontend
- Powerful, easy-to-manage database
The template also includes full-featured secure auth with:
- Token-based authentication
- Password recovery flow
- Role-based access control system
The design philosophy of the template is to prefer low-level, best-in-class open-source frameworks that offer flexibility, scalability, and performance without vendor-lock-in. You’ll find the template amazingly easy not only to understand and customize, but also to deploy to any major cloud hosting platform.
Core frameworks:
- FastAPI: scalable, high-performance, type-annotated Python web backend framework
- PostgreSQL: the world’s most advanced open-source database engine
- Jinja2: frontend HTML templating engine
- SQLModel: easy-to-use Python ORM
Additional technologies:
- uv: Python dependency manager
- Pytest: testing framework
- Docker: development containerization
- Github Actions: CI/CD pipeline
- Quarto: simple documentation website renderer
- MyPy: static type checker for Python
- Bootstrap: HTML/CSS styler
- Resend: zero- or low-cost email service used for password recovery
For comprehensive installation instructions, see the installation page.
MacOS and Linux:
wget -qO- https://astral.sh/uv/install.sh | shWindows:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"See the uv installation docs for more information.
Install Python 3.12 or higher from either the official downloads page or using uv:
# Installs the latest version
uv python installInstall Docker Desktop and Coker Compose for your operating system by following the instructions in the documentation.
For Ubuntu/Debian:
sudo apt update && sudo apt install -y python3-dev libpq-devFor macOS:
brew install postgresqlFor Windows:
- No installation required
From the root directory, run:
uv venv
uv syncThis will create an in-project virtual environment and install all dependencies.
Copy .env.example to .env with cp .env.example .env.
Generate a 256 bit secret key with openssl rand -base64 32 and paste
it into the .env file.
Set your desired database name, username, and password in the .env file.
To use password recovery, register a Resend account, verify a domain, get an API key, and paste the API key into the .env file.
To start the development database, run the following command in your terminal from the root directory:
docker compose up -dMake sure the development database is running and tables and default permissions/roles are created first.
uvicorn main:app --host 0.0.0.0 --port 8000 --reloadNavigate to http://localhost:8000/
mypy .In line with the llms.txt standard, we have provided a Markdown-formatted prompt—designed to help LLM agents understand how to work with this template—as a text file: llms.txt.
One use case for this file, if using the Cursor IDE, is to rename it to
.cursorrules and place it in your project directory (see the Cursor
docs on this for more
information). Alternatively, you could use it as a custom system prompt
in the web interface for ChatGPT, Claude, or the LLM of your choice.
We have also exposed the full Markdown-formatted project documentation as a single text file for easy downloading and embedding for RAG workflows.
Your contributions are welcome! See the issues page for ideas. Fork the repository, create a new branch, make your changes, and submit a pull request.
This project is created and maintained by Promptly Technologies, LLC and licensed under the MIT License. See the LICENSE file for more details.