Skip to content

Commit 1d79560

Browse files
Merge pull request #81 from osillano/main
Fix some typos and grammar in README
2 parents 8c0b9db + f75b050 commit 1d79560

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Introducing the Next.js FastAPI Template: A cutting-edge foundation for modern f
6161
* [Commercial Support](#commercial-support)
6262

6363
## 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.
6565

6666
- [Next.js](https://nextjs.org/): Fast, SEO-friendly frontend framework
6767
- [FastAPI](https://fastapi.tiangolo.com/): High-performance Python backend
@@ -91,7 +91,7 @@ This template streamlines building APIs with [FastAPI](https://fastapi.tiangolo.
9191

9292
With this setup, you'll save time and maintain a seamless connection between your backend and frontend, boosting productivity and reliability.
9393

94-
## Production-Ready Authentication & Dashboard features
94+
## Production-Ready Authentication & Dashboard Features
9595
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.
9696

9797
## Getting Started with This Template
@@ -114,7 +114,7 @@ Once completed, proceed to the [Setup](#setup) section below.
114114
#### 1. uv
115115
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/).
116116

117-
#### 2. Node.jsm, npm and pnpm
117+
#### 2. Node.js, npm and pnpm
118118
To run the frontend, ensure Node.js and npm are installed. Follow the [Node.js installation guide](https://nodejs.org/en/download/).
119119
After that, install pnpm by running:
120120
```bash
@@ -164,7 +164,7 @@ Copy the `.env.example` files to `.env`. These values are unlikely to change, so
164164
make docker-migrate-db
165165
```
166166

167-
### Build the project (without Docker):
167+
### Build the Project (without Docker):
168168
To set the project environment locally, use the following commands:
169169

170170
#### Backend
@@ -180,7 +180,7 @@ To set the project environment locally, use the following commands:
180180
pnpm install
181181
```
182182

183-
### Build the project (with Docker):
183+
### Build the Project (with Docker):
184184

185185
1. Build the backend and frontend containers:
186186
```bash
@@ -214,7 +214,7 @@ If you are using Docker:
214214
- **Backend**: Access the API at `http://localhost:8000`.
215215
- **Frontend**: Access the web application at `http://localhost:3000`.
216216

217-
### Hot Reload on development
217+
### Hot Reload on Development
218218
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.
219219

220220
- The **backend hot reload** monitors changes to the backend code.
@@ -441,8 +441,8 @@ You can do it with the following commands:
441441
- Once everything is set up, run `git push`, and the deployment will automatically occur.
442442
- Please ensure you complete the setup for both the frontend and backend separately.
443443
- 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.
446446

447447
## **Post-Deployment Configuration**
448448

@@ -469,7 +469,7 @@ You can do it with the following commands:
469469

470470
- For detailed instructions on setting these secret keys, please look at the section on [Setting up Environment Variables](#setting-up-environment-variables).
471471

472-
### Fluid serverless activation
472+
### Fluid Serverless Activation
473473
[Fluid](https://vercel.com/docs/functions/fluid-compute) is Vercel's new concurrency model for serverless functions, allowing them to handle multiple
474474
requests per execution instead of spinning up a new instance for each request. This improves performance,
475475
reduces cold starts, and optimizes resource usage, making serverless workloads more efficient.

0 commit comments

Comments
 (0)