Skip to content

Commit d4e8775

Browse files
authored
Merge pull request #78 from igorbenav/igorbenav-patch-1
Update README.md
2 parents 7eb6986 + 9e7e5fc commit d4e8775

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@
108108

109109
___
110110
## 3. Prerequisites
111+
### 3.0 Start
111112
Start by using the template, and naming the repository to what you want.
112113
<p align="left">
113114
<img src="https://user-images.githubusercontent.com/43156212/277866726-975d1c98-b1c9-4c8e-b4bd-001c8a5728cb.png" alt="clicking use this template button, then create a new repository option" width="35%" height="auto">
@@ -118,6 +119,15 @@ Then clone your created repository (I'm using the base for the example)
118119
git clone https://github.com/igormagalhaesr/FastAPI-boilerplate
119120
```
120121

122+
> [!TIP]
123+
> If you are in a hurry, you may use one of the following templates (containing a `.env`, `docker-compose.yml` and `Dockerfile`):
124+
- [Running locally with uvicorn](https://gist.github.com/igorbenav/48ad745120c3f77817e094f3a609111a)
125+
- [Runing in staging with gunicorn managing uvicorn workers](https://gist.github.com/igorbenav/d0518d4f6bdfb426d4036090f74905ee)
126+
- [Running in production with NGINX](https://gist.github.com/igorbenav/232c3b73339d6ca74e2bf179a5ef48a1)
127+
128+
> [!WARNING]
129+
> Do not forget to place `docker-compose.yml` and `Dockerfile` in the `root` folder, while `.env` should be in the `src` folder.
130+
121131
### 3.1 Environment Variables (.env)
122132

123133
Then create a `.env` file inside `src` directory:

0 commit comments

Comments
 (0)