mirror of
https://github.com/fastapi/full-stack-fastapi-template.git
synced 2026-11-03 20:36:27 +00:00
📝 Simplify project documentation (#2442)
This commit is contained in:
Sebastián Ramírez
committed by
GitHub
GitHub
parent
84c5a9e11a
commit
42b4ca0586
@@ -1,8 +1,7 @@
|
||||
# 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>
|
||||
[](../../actions/workflows/test-docker-compose.yml)
|
||||
[](../../actions/workflows/test-backend.yml)
|
||||
|
||||
## Technology Stack and Features
|
||||
|
||||
@@ -15,128 +14,41 @@
|
||||
- 💃 Using TypeScript, hooks, [Vite](https://vitejs.dev), and other parts of a modern frontend stack.
|
||||
- 🎨 [Tailwind CSS](https://tailwindcss.com) and [shadcn/ui](https://ui.shadcn.com) for the frontend components.
|
||||
- 🤖 An automatically generated frontend client.
|
||||
- 🧪 [Playwright](https://playwright.dev) for End-to-End testing.
|
||||
- 🧪 [Playwright](https://playwright.dev) for end-to-end testing.
|
||||
- 🦇 Dark mode support.
|
||||
- ☁️ [FastAPI Cloud](https://fastapicloud.com) for deployment.
|
||||
- 🐋 [Docker Compose](https://www.docker.com) for local services and self-hosted deployment.
|
||||
- 📞 [Traefik](https://traefik.io) as a reverse proxy with automatic HTTPS.
|
||||
- 🔒 Secure password hashing by default.
|
||||
- 🔑 JWT (JSON Web Token) authentication.
|
||||
- 📫 Email based password recovery.
|
||||
- 📫 Email-based password recovery.
|
||||
- 📬 [Mailcatcher](https://mailcatcher.me) for local email testing during development.
|
||||
- ✅ Tests with [Pytest](https://pytest.org).
|
||||
- 🚢 Deployment with FastAPI Cloud or self-hosting with Docker Compose and Traefik.
|
||||
- 🏭 CI (continuous integration) and CD (continuous deployment) based on GitHub Actions.
|
||||
|
||||
### Dashboard Login
|
||||
|
||||
[](https://github.com/fastapi/full-stack-fastapi-template)
|
||||
|
||||
|
||||
### Dashboard - Admin
|
||||
|
||||
[](https://github.com/fastapi/full-stack-fastapi-template)
|
||||
|
||||
|
||||
### Dashboard - Items
|
||||
|
||||
[](https://github.com/fastapi/full-stack-fastapi-template)
|
||||
|
||||
|
||||
### Dashboard - Dark Mode
|
||||
|
||||
[](https://github.com/fastapi/full-stack-fastapi-template)
|
||||
|
||||
|
||||
### Interactive API Documentation
|
||||
|
||||
[](https://github.com/fastapi/full-stack-fastapi-template)
|
||||
|
||||
|
||||
## How To Use It
|
||||
## How to Use It
|
||||
|
||||
You can **just fork or clone** this repository and use it as is.
|
||||
|
||||
✨ It just works. ✨
|
||||
|
||||
### 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`:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:fastapi/full-stack-fastapi-template.git my-full-stack
|
||||
```
|
||||
|
||||
- Enter into the new directory:
|
||||
|
||||
```bash
|
||||
cd my-full-stack
|
||||
```
|
||||
|
||||
- Set the new origin to your new repository, copy it from the GitHub interface, for example:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
git remote add upstream git@github.com:fastapi/full-stack-fastapi-template.git
|
||||
```
|
||||
|
||||
- Push the code to your new repository:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
git merge --continue
|
||||
```
|
||||
|
||||
### Configure
|
||||
|
||||
You can update the local settings in the `.env` file. Before deploying, configure the environment variables and secrets described in the [FastAPI Cloud deployment guide](./deployment.md) or the [Docker Compose deployment guide](./deployment-docker-compose.md). Never deploy with the default `changethis` values.
|
||||
|
||||
### 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:
|
||||
|
||||
```bash
|
||||
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.
|
||||
Click the **Use this template** button at the top of this page to create a new repository.
|
||||
|
||||
## Backend Development
|
||||
|
||||
@@ -148,9 +60,9 @@ Frontend docs: [frontend/README.md](./frontend/README.md).
|
||||
|
||||
## Deployment
|
||||
|
||||
Deployment docs: [deployment.md](./deployment.md).
|
||||
FastAPI Cloud deployment: [deployment.md](./deployment.md).
|
||||
|
||||
Docker Compose deployment: [deployment-docker-compose.md](./deployment-docker-compose.md).
|
||||
Self-hosted deployment with Docker Compose: [deployment-docker-compose.md](./deployment-docker-compose.md).
|
||||
|
||||
## Development
|
||||
|
||||
|
||||
Reference in New Issue
Block a user