Skip to content

Commit a4a20db

Browse files
committed
Updated README
1 parent a495df4 commit a4a20db

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

README.md

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@
44
<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>
55
<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>
66

7+
## Goals of This Fork
8+
9+
- 📁 Have the file structure more closely follow
10+
[zhanymkanov/fastapi-best-practices](https://github.com/zhanymkanov/fastapi-best-practices)
11+
and [Netflix/dispatch](https://github.com/Netflix/dispatch).
12+
- 📧 Support case insensitive email addresses.
13+
- The original template intentionally did not support case insensitive email
14+
addresses because according to [RFC
15+
5321](https://www.rfc-editor.org/rfc/rfc5321#section-2.3.11) email addresses can
16+
be case sensitive. In practice, most websites ignore the standard to simplify the
17+
experience for the end user.
18+
- ⚡ Automatically load models and routers based on the project folder structure.
19+
- 🧪 Run backend tests on a seperate test database.
20+
- 🧹 Stricter linter configurations.
21+
- 🏠 Set the default URL to be the root domain instead of the dashboard subdomain.
22+
- 📙 Changed Alembic to use timestamp based file names.
23+
724
## Technology Stack and Features
825

926
-[**FastAPI**](https://fastapi.tiangolo.com) for the Python backend API.
@@ -28,23 +45,23 @@
2845

2946
### Dashboard Login
3047

31-
[![API docs](img/login.png)](https://github.com/fastapi/full-stack-fastapi-template)
48+
[![API docs](img/login.png)](https://github.com/ryn-cx/full-stack-fastapi-template)
3249

3350
### Dashboard - Admin
3451

35-
[![API docs](img/dashboard.png)](https://github.com/fastapi/full-stack-fastapi-template)
52+
[![API docs](img/dashboard.png)](https://github.com/ryn-cx/full-stack-fastapi-template)
3653

3754
### Dashboard - Items
3855

39-
[![API docs](img/dashboard-items.png)](https://github.com/fastapi/full-stack-fastapi-template)
56+
[![API docs](img/dashboard-items.png)](https://github.com/ryn-cx/full-stack-fastapi-template)
4057

4158
### Dashboard - Dark Mode
4259

43-
[![API docs](img/dashboard-dark.png)](https://github.com/fastapi/full-stack-fastapi-template)
60+
[![API docs](img/dashboard-dark.png)](https://github.com/ryn-cx/full-stack-fastapi-template)
4461

4562
### Interactive API Documentation
4663

47-
[![API docs](img/docs.png)](https://github.com/fastapi/full-stack-fastapi-template)
64+
[![API docs](img/docs.png)](https://github.com/ryn-cx/full-stack-fastapi-template)
4865

4966
## How To Use It
5067

@@ -62,7 +79,7 @@ But you can do the following:
6279
- Clone this repository manually, set the name with the name of the project you want to use, for example `my-full-stack`:
6380

6481
```bash
65-
git clone git@github.com:fastapi/full-stack-fastapi-template.git my-full-stack
82+
git clone https://github.com/ryn-cx/full-stack-fastapi-template.git my-full-stack
6683
```
6784

6885
- Enter into the new directory:
@@ -74,13 +91,13 @@ cd my-full-stack
7491
- Set the new origin to your new repository, copy it from the GitHub interface, for example:
7592

7693
```bash
77-
git remote set-url origin git@github.com:octocat/my-full-stack.git
94+
git remote set-url origin https://github.com/octocat/my-full-stack.git
7895
```
7996

8097
- Add this repo as another "remote" to allow you to get updates later:
8198

8299
```bash
83-
git remote add upstream git@github.com:fastapi/full-stack-fastapi-template.git
100+
git remote add upstream https://github.com/ryn-cx/full-stack-fastapi-template.git
84101
```
85102

86103
- Push the code to your new repository:
@@ -98,10 +115,10 @@ After cloning the repository, and after doing changes, you might want to get the
98115
```bash
99116
git remote -v
100117

101-
origin git@github.com:octocat/my-full-stack.git (fetch)
102-
origin git@github.com:octocat/my-full-stack.git (push)
103-
upstream git@github.com:fastapi/full-stack-fastapi-template.git (fetch)
104-
upstream git@github.com:fastapi/full-stack-fastapi-template.git (push)
118+
origin https://github.com/octocat/my-full-stack.git (fetch)
119+
origin https://github.com/octocat/my-full-stack.git (push)
120+
upstream https://github.com/ryn-cx/full-stack-fastapi-template.git (fetch)
121+
upstream https://github.com/ryn-cx/full-stack-fastapi-template.git (push)
105122
```
106123

107124
- Pull the latest changes without merging:
@@ -175,16 +192,16 @@ Decide a name for your new project's directory, you will use it below. For examp
175192
Go to the directory that will be the parent of your project, and run the command with your project's name:
176193

177194
```bash
178-
copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust
195+
copier copy https://github.com/ryn-cx/full-stack-fastapi-template my-awesome-project --trust
179196
```
180197

181198
If you have `pipx` and you didn't install `copier`, you can run it directly:
182199

183200
```bash
184-
pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust
201+
pipx run copier copy https://github.com/ryn-cx/full-stack-fastapi-template my-awesome-project --trust
185202
```
186203

187-
**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.
204+
**Note** the `--trust` option is necessary to be able to execute a [post-creation script](https://github.com/ryn-cx/full-stack-fastapi-template/blob/master/.copier/update_dotenv.py) that updates your `.env` files.
188205

189206
### Input Variables
190207

0 commit comments

Comments
 (0)