🚚 Rename project to Full Stack FastAPI Template (#699)
This commit is contained in:
Sebastián Ramírez
committed by
GitHub
GitHub
parent
964e605bcd
commit
b32dea360c
138
README.md
138
README.md
@@ -1,57 +1,7 @@
|
||||
<p align="center">
|
||||
<a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/actions?query=workflow%3ATest" target="_blank">
|
||||
<img src="https://github.com/tiangolo/full-stack-fastapi-postgresql/workflows/Test/badge.svg" alt="Test">
|
||||
</a>
|
||||
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/full-stack-fastapi-postgresql" target="_blank">
|
||||
<img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/full-stack-fastapi-postgresql.svg" alt="Coverage">
|
||||
</p>
|
||||
# Full Stack FastAPI Template
|
||||
|
||||
# FastAPI Project Template
|
||||
|
||||
## 🚨 Warning: in (re) construction 😎 🏗️
|
||||
|
||||
This project is currently being restructured, don't use it right now, hold for a bit.
|
||||
|
||||
In the next couple of weeks it will be ready. 😎 🚀
|
||||
|
||||
Some of the future new features and changes:
|
||||
|
||||
- [x] Upgrade to the latest FastAPI.
|
||||
- [x] Migration from SQLAlchemy to SQLModel.
|
||||
- [x] Upgrade to Pydantic v2.
|
||||
- [x] Refactor and simplification of most of the code, a lot of the complexity won't be necessary anymore.
|
||||
- [x] Automatic TypeScript frontend client generated from the FastAPI API (OpenAPI).
|
||||
- [x] Migrate from Vue.js 2 to React 18 with TypeScript.
|
||||
- [x] Make the project work as is, allowing to clone and use (not requiring to generate a project with Cookiecutter or Copier)
|
||||
- [x] Migrate from Cookiecutter to Copier
|
||||
- [x] Move from Docker Swarm Model to Docker Compose for a simple deployment.
|
||||
- [x] GitHub Actions for CI.
|
||||
|
||||
---
|
||||
|
||||
### Interactive API documentation
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-postgresql)
|
||||
|
||||
### Dashboard Login
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-postgresql)
|
||||
|
||||
### Dashboard - Admin
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-postgresql)
|
||||
|
||||
### Dashboard - Create User
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-postgresql)
|
||||
|
||||
### Dashboard - Items
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-postgresql)
|
||||
|
||||
### Dashboard - User Settings
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-postgresql)
|
||||
<a href="https://github.com/tiangolo/full-stack-fastapi-template/actions?query=workflow%3ATest" target="_blank"><img src="https://github.com/tiangolo/full-stack-fastapi-template/workflows/Test/badge.svg" alt="Test"></a>
|
||||
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/full-stack-fastapi-template" target="_blank"><img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/full-stack-fastapi-template.svg" alt="Coverage"></a>
|
||||
|
||||
## Technology Stack and Features
|
||||
|
||||
@@ -72,6 +22,32 @@ Some of the future new features and changes:
|
||||
- 🚢 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
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-template)
|
||||
|
||||
### Dashboard - Admin
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-template)
|
||||
|
||||
### Dashboard - Create User
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-template)
|
||||
|
||||
### Dashboard - Items
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-template)
|
||||
|
||||
### Dashboard - User Settings
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-template)
|
||||
|
||||
### Interactive API documentation
|
||||
|
||||
[](https://github.com/tiangolo/full-stack-fastapi-template)
|
||||
|
||||
|
||||
|
||||
## How to use it
|
||||
|
||||
You can **just fork or clone** this repository and use it as is.
|
||||
@@ -82,7 +58,11 @@ You can **just fork or clone** this repository and use it as is.
|
||||
|
||||
You can then update configs in the `.env` files to customize your configurations.
|
||||
|
||||
Make sure you at least change the value for `SECRET_KEY` in the main `.env` file before deploying to production.
|
||||
Before deploying it, make sure you change at least the values for:
|
||||
|
||||
- `SECRET_KEY`
|
||||
- `FIRST_SUPERUSER_PASSWORD`
|
||||
- `POSTGRES_PASSWORD`
|
||||
|
||||
### Generate secret keys
|
||||
|
||||
@@ -98,7 +78,7 @@ Copy the content and use that as password / secret key. And run that again to ge
|
||||
|
||||
## How to use it - alternative with Copier
|
||||
|
||||
This project template also supports generating a new project using [Copier](https://copier.readthedocs.io).
|
||||
This repository also supports generating a new project using [Copier](https://copier.readthedocs.io).
|
||||
|
||||
It will copy all the files, ask you configuration questions, and update the `.env` files with your answers.
|
||||
|
||||
@@ -125,16 +105,16 @@ Decide a name for your new project's directory, you will use it below. For examp
|
||||
Go to the directory that will be the parent of your project, and run the command with your project's name:
|
||||
|
||||
```bash
|
||||
copier copy https://github.com/tiangolo/full-stack-fastapi-postgresql my-awesome-project --trust
|
||||
copier copy https://github.com/tiangolo/full-stack-fastapi-template my-awesome-project --trust
|
||||
```
|
||||
|
||||
If you have `pipx` and you didn't install `copier`, you can run it directly:
|
||||
|
||||
```bash
|
||||
pipx run copier copy https://github.com/tiangolo/full-stack-fastapi-postgresql my-awesome-project --trust
|
||||
pipx run copier copy https://github.com/tiangolo/full-stack-fastapi-template my-awesome-project --trust
|
||||
```
|
||||
|
||||
**Note** the `--trust` option is necessary to be able to execute a [post-creation script](https://github.com/tiangolo/full-stack-fastapi-postgresql/blob/master/.copier/update_dotenv.py) that updates your `.env` files.
|
||||
**Note** the `--trust` option is necessary to be able to execute a [post-creation script](https://github.com/tiangolo/full-stack-fastapi-template/blob/master/.copier/update_dotenv.py) that updates your `.env` files.
|
||||
|
||||
### Input variables
|
||||
|
||||
@@ -156,32 +136,28 @@ The input variables, with their default values (some auto generated) are:
|
||||
- `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
|
||||
|
||||
Backend docs: [backend/README.md](./backend/README.md).
|
||||
|
||||
## Frontend Development
|
||||
|
||||
Frontend docs: [frontend/README.md](./frontend/README.md).
|
||||
|
||||
## Deployment
|
||||
|
||||
Deployment docs: [deployment.md](./deployment.md).
|
||||
|
||||
## Development
|
||||
|
||||
General development docs: [development.md](./development.md).
|
||||
|
||||
This includes using Docker Compose, custom local domains, `.env` configurations, etc.
|
||||
|
||||
## Release Notes
|
||||
|
||||
Check the file [release-notes.md](./release-notes.md).
|
||||
|
||||
## License
|
||||
|
||||
The FastAPI Project Template is licensed under the terms of the MIT license.
|
||||
|
||||
---
|
||||
|
||||
The documentation below is for **your own project**, not the Project Template. 👇
|
||||
|
||||
## Backend Development
|
||||
|
||||
See more instructions specific to backend development in [backend/README.md](./backend/README.md).
|
||||
|
||||
## Frontend Development
|
||||
|
||||
See more instructions specific to frontend development in [frontend/README.md](./frontend/README.md).
|
||||
|
||||
## Deployment
|
||||
|
||||
See more instructions specific to deployment in [deployment.md](./deployment.md).
|
||||
|
||||
## Development
|
||||
|
||||
See general development instructions in [development.md](./development.md).
|
||||
|
||||
This includes using Docker Compose, custom local domains, `.env` configurations, etc.
|
||||
The Full Stack FastAPI Template is licensed under the terms of the MIT license.
|
||||
|
||||
Reference in New Issue
Block a user