You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ Introducing the Next.js FastAPI Template: A cutting-edge foundation for modern f
61
61
*[Commercial Support](#commercial-support)
62
62
63
63
## About
64
-
This template streamlines building APIs with [FastAPI](https://fastapi.tiangolo.com/) and dynamic frontends with [Next.js](https://nextjs.org/). It integrates the backend and frontend using [@hey-api/openapi-ts](https://github.com/hey-ai/openapi-ts) to generate a type-safe client, with automated watchers to keep the OpenAPI schema and client updated, ensuring a smooth and synchronized development workflow.
64
+
This template streamlines building APIs with [FastAPI](https://fastapi.tiangolo.com/) and dynamic frontends with [Next.js](https://nextjs.org/). It integrates the backend and frontend using [@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) to generate a type-safe client, with automated watchers to keep the OpenAPI schema and client updated, ensuring a smooth and synchronized development workflow.
@@ -91,7 +91,7 @@ This template streamlines building APIs with [FastAPI](https://fastapi.tiangolo.
91
91
92
92
With this setup, you'll save time and maintain a seamless connection between your backend and frontend, boosting productivity and reliability.
93
93
94
-
## Production-Ready Authentication & Dashboard features
94
+
## Production-Ready Authentication & Dashboard Features
95
95
This template comes with a pre-configured authentication system and a simple dashboard interface, allowing you to start building your application with user management features immediately.
96
96
97
97
## Getting Started with This Template
@@ -114,7 +114,7 @@ Once completed, proceed to the [Setup](#setup) section below.
114
114
#### 1. uv
115
115
uv is used to manage Python dependencies in the backend. Install uv by following the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/).
116
116
117
-
#### 2. Node.jsm, npm and pnpm
117
+
#### 2. Node.js, npm and pnpm
118
118
To run the frontend, ensure Node.js and npm are installed. Follow the [Node.js installation guide](https://nodejs.org/en/download/).
119
119
After that, install pnpm by running:
120
120
```bash
@@ -164,7 +164,7 @@ Copy the `.env.example` files to `.env`. These values are unlikely to change, so
164
164
make docker-migrate-db
165
165
```
166
166
167
-
### Build the project (without Docker):
167
+
### Build the Project (without Docker):
168
168
To set the project environment locally, use the following commands:
169
169
170
170
#### Backend
@@ -180,7 +180,7 @@ To set the project environment locally, use the following commands:
180
180
pnpm install
181
181
```
182
182
183
-
### Build the project (with Docker):
183
+
### Build the Project (with Docker):
184
184
185
185
1. Build the backend and frontend containers:
186
186
```bash
@@ -214,7 +214,7 @@ If you are using Docker:
214
214
-**Backend**: Access the API at `http://localhost:8000`.
215
215
-**Frontend**: Access the web application at `http://localhost:3000`.
216
216
217
-
### Hot Reload on development
217
+
### Hot Reload on Development
218
218
The project includes two hot reloads running the application, one for the backend and one for the frontend. These automatically restart local servers when they detect changes, ensuring that the application is always up to date without needing manual restarts.
219
219
220
220
- The **backend hot reload** monitors changes to the backend code.
@@ -441,8 +441,8 @@ You can do it with the following commands:
441
441
- Once everything is set up, run `git push`, and the deployment will automatically occur.
442
442
- Please ensure you complete the setup for both the frontend and backend separately.
443
443
- Refer to the [Vercel CLI Documentation](https://vercel.com/docs/cli) for more details.
444
-
- You can find the project_id into the vercel web project settings.
445
-
- You can find the organization_id into the vercel web organization settings.
444
+
- You can find the project_id in the vercel web project settings.
445
+
- You can find the organization_id in the vercel web organization settings.
446
446
447
447
## **Post-Deployment Configuration**
448
448
@@ -469,7 +469,7 @@ You can do it with the following commands:
469
469
470
470
- For detailed instructions on setting these secret keys, please look at the section on [Setting up Environment Variables](#setting-up-environment-variables).
471
471
472
-
### Fluid serverless activation
472
+
### Fluid Serverless Activation
473
473
[Fluid](https://vercel.com/docs/functions/fluid-compute) is Vercel's new concurrency model for serverless functions, allowing them to handle multiple
474
474
requests per execution instead of spinning up a new instance for each request. This improves performance,
475
475
reduces cold starts, and optimizes resource usage, making serverless workloads more efficient.
0 commit comments