@ -1,7 +1,7 @@
# Full Stack FastAPI Template
< 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 >
< a href = "https://github.com/fas tap i/full-stack-fastapi-template/actions?query=workflow%3ATest" target = "_blank" > < img src = "https://github.com/fas tap i/full-stack-fastapi-template/workflows/Test/badge.svg" alt = "Test" > < / a >
< a href = "https://coverage-badge.samuelcolvin.workers.dev/redirect/fas tap i/full-stack-fastapi-template" target = "_blank" > < img src = "https://coverage-badge.samuelcolvin.workers.dev/fas tap i/full-stack-fastapi-template.svg" alt = "Coverage" > < / a >
## Technology Stack and Features
@ -26,31 +26,31 @@
### Dashboard Login
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
### Dashboard - Admin
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
### Dashboard - Create User
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
### Dashboard - Items
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
### Dashboard - User Settings
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
### Dashboard - Dark Mode
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
### Interactive API Documentation
[](https://github.com/tiangolo /full-stack-fastapi-template)
[](https://github.com/fas tap i/full-stack-fastapi-template)
## How To Use It
@ -68,7 +68,7 @@ But you can do the following:
- 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:tiangolo /full-stack-fastapi-template.git my-full-stack
git clone git@github.com:fas tap i/full-stack-fastapi-template.git my-full-stack
```
- Enter into the new directory:
@ -86,7 +86,7 @@ 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:tiangolo /full-stack-fastapi-template.git
git remote add upstream git@github.com:fas tap i/full-stack-fastapi-template.git
```
- Push the code to your new repository:
@ -106,8 +106,8 @@ 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:tiangolo /full-stack-fastapi-template.git (fetch)
upstream git@github.com:tiangolo /full-stack-fastapi-template.git (push)
upstream git@github.com:fas tap i/full-stack-fastapi-template.git (fetch)
upstream git@github.com:fas tap i/full-stack-fastapi-template.git (push)
```
- Pull the latest changes without merging:
@ -181,16 +181,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-template my-awesome-project --trust
copier copy https://github.com/fas tap i/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-template my-awesome-project --trust
pipx run copier copy https://github.com/fas tap i/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-template/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/fas tap i/full-stack-fastapi-template/blob/master/.copier/update_dotenv.py ) that updates your `.env` files.
### Input Variables