1
1
# Full Stack FastAPI Template
2
2
3
- <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 >
4
- <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 >
3
+ <a href =" https://github.com/fastapi /full-stack-fastapi-template/actions?query=workflow%3ATest " target =" _blank " ><img src =" https://github.com/fastapi /full-stack-fastapi-template/workflows/Test/badge.svg " alt =" Test " ></a >
4
+ <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 >
5
5
6
6
## Technology Stack and Features
7
7
26
26
27
27
### Dashboard Login
28
28
29
- [ ![ API docs] ( img/login.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
29
+ [ ![ API docs] ( img/login.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
30
30
31
31
### Dashboard - Admin
32
32
33
- [ ![ API docs] ( img/dashboard.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
33
+ [ ![ API docs] ( img/dashboard.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
34
34
35
35
### Dashboard - Create User
36
36
37
- [ ![ API docs] ( img/dashboard-create.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
37
+ [ ![ API docs] ( img/dashboard-create.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
38
38
39
39
### Dashboard - Items
40
40
41
- [ ![ API docs] ( img/dashboard-items.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
41
+ [ ![ API docs] ( img/dashboard-items.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
42
42
43
43
### Dashboard - User Settings
44
44
45
- [ ![ API docs] ( img/dashboard-user-settings.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
45
+ [ ![ API docs] ( img/dashboard-user-settings.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
46
46
47
47
### Dashboard - Dark Mode
48
48
49
- [ ![ API docs] ( img/dashboard-dark.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
49
+ [ ![ API docs] ( img/dashboard-dark.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
50
50
51
51
### Interactive API Documentation
52
52
53
- [ ![ API docs] ( img/docs.png )] ( https://github.com/tiangolo /full-stack-fastapi-template )
53
+ [ ![ API docs] ( img/docs.png )] ( https://github.com/fastapi /full-stack-fastapi-template )
54
54
55
55
## How To Use It
56
56
@@ -68,7 +68,7 @@ But you can do the following:
68
68
- Clone this repository manually, set the name with the name of the project you want to use, for example ` my-full-stack ` :
69
69
70
70
``` bash
71
- git clone
[email protected] :
tiangolo /full-stack-fastapi-template.git my-full-stack
71
+ git clone
[email protected] :
fastapi /full-stack-fastapi-template.git my-full-stack
72
72
```
73
73
74
74
- Enter into the new directory:
@@ -86,7 +86,7 @@ git remote set-url origin
[email protected] :octocat/my-full-stack.git
86
86
- Add this repo as another "remote" to allow you to get updates later:
87
87
88
88
``` bash
89
- git remote add upstream
[email protected] :
tiangolo /full-stack-fastapi-template.git
89
+ git remote add upstream
[email protected] :
fastapi /full-stack-fastapi-template.git
90
90
```
91
91
92
92
- Push the code to your new repository:
@@ -106,8 +106,8 @@ git remote -v
106
106
107
107
origin
[email protected] :octocat/my-full-stack.git (fetch)
108
108
origin
[email protected] :octocat/my-full-stack.git (push)
109
- upstream
[email protected] :
tiangolo /full-stack-fastapi-template.git (fetch)
110
- upstream
[email protected] :
tiangolo /full-stack-fastapi-template.git (push)
109
+ upstream
[email protected] :
fastapi /full-stack-fastapi-template.git (fetch)
110
+ upstream
[email protected] :
fastapi /full-stack-fastapi-template.git (push)
111
111
```
112
112
113
113
- 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
181
181
Go to the directory that will be the parent of your project, and run the command with your project's name:
182
182
183
183
``` bash
184
- copier copy https://github.com/tiangolo /full-stack-fastapi-template my-awesome-project --trust
184
+ copier copy https://github.com/fastapi /full-stack-fastapi-template my-awesome-project --trust
185
185
```
186
186
187
187
If you have ` pipx ` and you didn't install ` copier ` , you can run it directly:
188
188
189
189
``` bash
190
- pipx run copier copy https://github.com/tiangolo /full-stack-fastapi-template my-awesome-project --trust
190
+ pipx run copier copy https://github.com/fastapi /full-stack-fastapi-template my-awesome-project --trust
191
191
```
192
192
193
- ** 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.
193
+ ** Note** the ` --trust ` option is necessary to be able to execute a [ post-creation script] ( https://github.com/fastapi /full-stack-fastapi-template/blob/master/.copier/update_dotenv.py ) that updates your ` .env ` files.
194
194
195
195
### Input Variables
196
196
0 commit comments