Skip to content

Commit 31cccc0

Browse files
committed
Copyright infringement
1 parent f46fd55 commit 31cccc0

File tree

7 files changed

+22
-73
lines changed

7 files changed

+22
-73
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastAPI Project - Backend
1+
# Backend
22

33
## Requirements
44

deployment.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastAPI Project - Deployment
1+
# Deployment
22

33
You can deploy the project using Docker Compose to a remote server.
44

@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓
1212

1313
* Have a remote server ready and available.
1414
* Configure the DNS records of your domain to point to the IP of the server you just created.
15-
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
15+
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.project.example.com`. This will be useful for accessing different components, like `traefik.project.example.com`, `adminer.project.example.com`, etc. And also for `staging`, like `staging.project.example.com`, `staging.adminer.project.example.com`, etc.
1616
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).
1717

1818
## Public Traefik
@@ -78,7 +78,7 @@ echo $HASHED_PASSWORD
7878
* Create an environment variable with the domain name for your server, e.g.:
7979

8080
```bash
81-
export DOMAIN=fastapi-project.example.com
81+
export DOMAIN=project.example.com
8282
```
8383

8484
* Create an environment variable with the email for Let's Encrypt, e.g.:
@@ -103,9 +103,9 @@ Now with the environment variables set and the `docker-compose.traefik.yml` in p
103103
docker compose -f docker-compose.traefik.yml up -d
104104
```
105105

106-
## Deploy the FastAPI Project
106+
## Deploy the Project
107107

108-
Now that you have Traefik in place you can deploy your FastAPI project with Docker Compose.
108+
Now that you have Traefik in place you can deploy your project with Docker Compose.
109109

110110
**Note**: You might want to jump ahead to the section about Continuous Deployment with GitHub Actions.
111111

@@ -122,15 +122,15 @@ export ENVIRONMENT=production
122122
Set the `DOMAIN`, by default `localhost` (for development), but when deploying you would use your own domain, for example:
123123

124124
```bash
125-
export DOMAIN=fastapi-project.example.com
125+
export DOMAIN=project.example.com
126126
```
127127

128128
You can set several variables, like:
129129

130130
* `PROJECT_NAME`: The name of the project, used in the API for the docs and emails.
131-
* `STACK_NAME`: The name of the stack used for Docker Compose labels and project name, this should be different for `staging`, `production`, etc. You could use the same domain replacing dots with dashes, e.g. `fastapi-project-example-com` and `staging-fastapi-project-example-com`.
131+
* `STACK_NAME`: The name of the stack used for Docker Compose labels and project name, this should be different for `staging`, `production`, etc. You could use the same domain replacing dots with dashes, e.g. `project-example-com` and `staging-project-example-com`.
132132
* `BACKEND_CORS_ORIGINS`: A list of allowed CORS origins separated by commas.
133-
* `SECRET_KEY`: The secret key for the FastAPI project, used to sign tokens.
133+
* `SECRET_KEY`: The secret key for the project, used to sign tokens.
134134
* `FIRST_SUPERUSER`: The email of the first superuser, this superuser will be the one that can create new users.
135135
* `FIRST_SUPERUSER_PASSWORD`: The password of the first superuser.
136136
* `SMTP_HOST`: The SMTP server host to send emails, this would come from your email provider (E.g. Mailgun, Sparkpost, Sendgrid, etc).
@@ -276,28 +276,28 @@ If you need to add extra environments you could use those as a starting point.
276276

277277
## URLs
278278

279-
Replace `fastapi-project.example.com` with your domain.
279+
Replace `project.example.com` with your domain.
280280

281281
### Main Traefik Dashboard
282282

283-
Traefik UI: `https://traefik.fastapi-project.example.com`
283+
Traefik UI: `https://traefik.project.example.com`
284284

285285
### Production
286286

287-
Frontend: `https://fastapi-project.example.com`
287+
Frontend: `https://project.example.com`
288288

289-
Backend API docs: `https://fastapi-project.example.com/docs`
289+
Backend API docs: `https://project.example.com/docs`
290290

291-
Backend API base URL: `https://fastapi-project.example.com/api/`
291+
Backend API base URL: `https://project.example.com/api/`
292292

293-
Adminer: `https://adminer.fastapi-project.example.com`
293+
Adminer: `https://adminer.project.example.com`
294294

295295
### Staging
296296

297-
Frontend: `https://staging.fastapi-project.example.com`
297+
Frontend: `https://staging.project.example.com`
298298

299-
Backend API docs: `https://staging.fastapi-project.example.com/docs`
299+
Backend API docs: `https://staging.project.example.com/docs`
300300

301-
Backend API base URL: `https://staging.fastapi-project.example.com/api/`
301+
Backend API base URL: `https://staging.project.example.com/api/`
302302

303-
Adminer: `https://adminer.staging.fastapi-project.example.com`
303+
Adminer: `https://adminer.staging.project.example.com`

development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastAPI Project - Development
1+
# Development
22

33
## Development in `localhost` with a custom domain
44

frontend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastAPI Project - Frontend
1+
# Frontend
22

33
The frontend is built with [Vite](https://vitejs.dev/), [React](https://reactjs.org/), [TypeScript](https://www.typescriptlang.org/), [TanStack Query](https://tanstack.com/query), [TanStack Router](https://tanstack.com/router) and [Chakra UI](https://chakra-ui.com/).
44

frontend/public/assets/images/fastapi-logo.svg

Lines changed: 0 additions & 51 deletions
This file was deleted.
-4.92 KB
Binary file not shown.

frontend/src/routes/login.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ function Login() {
7878
>
7979
<Image
8080
src={Logo}
81-
alt="FastAPI logo"
81+
alt="Logo"
8282
height="auto"
8383
maxW="2xs"
8484
alignSelf="center"

0 commit comments

Comments
 (0)