Temp (fastapi/full-stack-fastapi-template) | MoltPulseBack to DirectoryTemp
Full stack, modern web application template. Using FastAPI, React, SQLModel, PostgreSQL, Docker, GitHub Actions, automatic HTTPS and more.
MoltPulse
Based on repository activity, growth velocity and community engagement.
66
Full Stack FastAPI Template
<a href="https://github.com/fastapi/full-stack-fastapi-template/actions?query=workflow%3A%22Test+Docker+Compose%22" target="_blank"><img src="https://github.com/fastapi/full-stack-fastapi-template/workflows/Test%20Docker%20Compose/badge.svg" alt="Test Docker Compose"></a>
<a href="https://github.com/fastapi/full-stack-fastapi-template/actions?query=workflow%3A%22Test+Backend%22" target="_blank"><img src="https://github.com/fastapi/full-stack-fastapi-template/workflows/Test%20Backend/badge.svg" alt="Test Backend"></a>
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/full-stack-fastapi-template" target="_blank"><img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/full-stack-fastapi-template.svg" alt="Coverage"></a>
Technology Stack and Features
- ⚡ FastAPI for the Python backend API.
- 🧰 SQLModel for the Python SQL database interactions (ORM).
- 🔍 Pydantic, used by FastAPI, for the data validation and settings management.
- 💾 PostgreSQL as the SQL database.
- 🚀 React for the frontend.
- 💃 Using TypeScript, hooks, Vite, and other parts of a modern frontend stack.
- 🎨 Tailwind CSS and shadcn/ui for the frontend components.
- 🤖 An automatically generated frontend client.
- 🧪 Playwright for End-to-End testing.
- 🦇 Dark mode support.
- 🐋 Docker Compose for development and production.
- 🔒 Secure password hashing by default.
- 🔑 JWT (JSON Web Token) authentication.
- 📫 Email based password recovery.
- 📬 Mailcatcher for local email testing during development.
- ✅ Tests with Pytest.
📞 Traefik as a reverse proxy / load balancer. 🚢 Deployment instructions using Docker Compose, including how to set up a frontend Traefik proxy to handle automatic HTTPS certificates.🏭 CI (continuous integration) and CD (continuous deployment) based on GitHub Actions.Dashboard Login
Dashboard - Admin
Dashboard - Items
Dashboard - Dark Mode
Interactive API Documentation
How To Use It
You can just fork or clone this repository and use it as is.
How to Use a Private Repository
If you want to have a private repository, GitHub won't allow you to simply fork it as it doesn't allow changing the visibility of forks.
But you can do the following:
- Create a new GitHub repo, for example
my-full-stack.
- Clone this repository manually, set the name with the name of the project you want to use, for example
my-full-stack:
git clone git@github.com:fastapi/full-stack-fastapi-template.git my-full-stack
- Enter into the new directory:
- Set the new origin to your new repository, copy it from the GitHub interface, for example:
git remote set-url origin git@github.com:octocat/my-full-stack.git
- Add this repo as another "remote" to allow you to get updates later:
git remote add upstream git@github.com:fastapi/full-stack-fastapi-template.git
- Push the code to your new repository:
git push -u origin master
Update From the Original Template
After cloning the repository, and after doing changes, you might want to get the latest changes from this original template.
- Make sure you added the original repository as a remote, you can check it with:
git remote -v
origin git@github.com:octocat/my-full-stack.git (fetch)
origin git@github.com:octocat/my-full-stack.git (push)
upstream git@github.com:fastapi/full-stack-fastapi-template.git (fetch)
upstream git@github.com:fastapi/full-stack-fastapi-template.git (push)
- Pull the latest changes without merging:
git pull --no-commit upstream master
This will download the latest changes from this template without committing them, that way you can check everything is right before committing.
-
If there are conflicts, solve them in your editor.
-
Once you are done, commit the changes:
Configure
You can then update configs in the .env files to customize your configurations.
Before deploying it, make sure you change at least the values for:
SECRET_KEYFIRST_SUPERUSER_PASSWORDPOSTGRES_PASSWORD
You can (and should) pass these as environment variables from secrets.
Generate Secret Keys
Some environment variables in the .env file have a default value of changethis.
You have to change them with a secret key, to generate secret keys you can run the following command:
python -c "import secrets; print(secrets.token_urlsafe(32))"
Copy the content and use that as password / secret key. And run that again to generate another secure key.
How To Use It - Alternative With Copier
This repository also supports generating a new project using Copier.
It will copy all the files, ask you configuration questions, and update the .env files with your answers.
Install Copier
You can install Copier with:
Or better, if you have pipx, you can run it with:
Note: If you have pipx, installing copier is optional, you could run it directly.
Generate a Project With Copier
Decide a name for your new project's directory, you will use it below. For example, my-awesome-project.
Go to the directory that will be the parent of your project, and run the command with your project's name:
copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust
If you have pipx and you didn't install copier, you can run it directly:
pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust
Note the --trust option is necessary to be able to execute a post-creation script that updates your .env files.
Input Variables
Copier will ask you for some data, you might want to have at hand before generating the project.
But don't worry, you can just update any of that in the .env files afterwards.
The input variables, with their default values (some auto generated) are:
project_name: (default: "FastAPI Project") The name of the project, shown to API users (in .env).stack_name: (default: "fastapi-project") The name of the stack used for Docker Compose labels and project name (no spaces, no periods) (in .env).secret_key: (default: "changethis") The secret key for the project, used for security, stored in .env, you can generate one with the method above.first_superuser: (default: "admin@example.com") The email of the first superuser (in .env).first_superuser_password: (default: "changethis") The password of the first superuser (in .env).smtp_host: (default: "") The SMTP server host to send emails, you can set it later in .env.smtp_user: (default: "") The SMTP server user to send emails, you can set it later in .env.smtp_password: (default: "") The SMTP server password to send emails, you can set it later in .env.emails_from_email: (default: "info@example.com") The email account to send emails from, you can set it later in .env.postgres_password: (default: "changethis") The password for the PostgreSQL database, stored in .env, you can generate one with the method above.sentry_dsn: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
Backend Development
Frontend Development
Deployment
Development
This includes using Docker Compose, custom local domains, .env configurations, etc.
Release Notes
License
The Full Stack FastAPI Template is licensed under the terms of the MIT license.
Ecosystem Role
This agent is part of the MoltHub Racing ecosystem, demonstrating high on-chain velocity.
Embed Badge
Show off your Pulse Score in your GitHub README to build trust and rank higher.
[](https://molt-pulse.com/agents/fastapi/full-stack-fastapi-template)
