Skip to content

Commit 4e62390

Browse files
committed
last typos in README.md
Signed-off-by: rafsaf <rafal.safin12@gmail.com>
1 parent dcc2f9a commit 4e62390

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ _Check out online example: [https://minimal-fastapi-postgres-template.rafsaf.pl]
1313
- [Features](#features)
1414
- [Quickstart](#quickstart)
1515
- [1. Create repository from a template](#1-create-repository-from-a-template)
16-
- [2. Install dependecies with uv](#2-install-dependecies-with-uv)
16+
- [2. Install dependencies with uv](#2-install-dependencies-with-uv)
1717
- [3. Run app](#3-run-app)
1818
- [4. Activate pre-commit](#4-activate-pre-commit)
1919
- [5. Running tests](#5-running-tests)
@@ -32,7 +32,7 @@ _Check out online example: [https://minimal-fastapi-postgres-template.rafsaf.pl]
3232
- [Registration](#registration)
3333
- [Delete user endpoint](#delete-user-endpoint)
3434
- [JWT and refresh tokens](#jwt-and-refresh-tokens)
35-
- [Writting scripts / cron](#writting-scripts--cron)
35+
- [Writing scripts / cron](#writing-scripts--cron)
3636
- [Docs URL](#docs-url)
3737
- [CORS](#cors)
3838
- [Allowed Hosts](#allowed-hosts)
@@ -63,7 +63,7 @@ Enjoy!
6363

6464
See [docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) or just use git clone.
6565

66-
### 2. Install dependecies with [uv](https://docs.astral.sh/uv/getting-started/installation/)
66+
### 2. Install dependencies with [uv](https://docs.astral.sh/uv/getting-started/installation/)
6767

6868
```bash
6969
cd your_project_name
@@ -407,13 +407,13 @@ Rethink `delete_current_user`, maybe you don't need it.
407407

408408
By using `/auth/access-token` user can exchange username + password for JWT. Refresh tokens is saved **in database table**. I've seen a lot of other, not always secure or sane setups. It's up to you if you want to change it to be also JWT (which seems to be popular), just one small note: It's `good` design if one can revoke all or preferably some refresh tokens. It's much `worse` design if one cannot. On the other hand, it's fine not to have option to revoke access tokens (as they are shortlived).
409409

410-
### Writting scripts / cron
410+
### Writing scripts / cron
411411

412412
Very rarely app has not some kind of background tasks. Feel free to use `new_script_async_session` if you need to have access to database outside of FastAPI. Cron can be simply: new file, async task with session (doing something), wrapped by `asyncio.run(script_func())`.
413413

414414
### Docs URL
415415

416-
Docs page is simpy `/` (by default in FastAPI it is `/docs`). You can change it completely for the project, just as title, version, etc.
416+
Docs page is simply `/` (by default in FastAPI it is `/docs`). You can change it completely for the project, just as title, version, etc.
417417

418418
```python
419419
app = FastAPI(
@@ -427,7 +427,7 @@ app = FastAPI(
427427

428428
### CORS
429429

430-
If you are not sure what are CORS for, follow [developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS). Most frontend frameworks nowadays operate on `http://localhost:3000` thats why it's included in `BACKEND_CORS_ORIGINS` in `.env` file, before going production be sure to include your frontend domain there, like `https://my-fontend-app.example.com`.
430+
If you are not sure what are CORS for, follow [developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS). Most frontend frameworks nowadays operate on `http://localhost:3000` thats why it's included in `BACKEND_CORS_ORIGINS` in `.env` file, before going production be sure to include your frontend domain there, like `https://my-frontend-app.example.com`.
431431

432432
```python
433433
app.add_middleware(
@@ -441,7 +441,7 @@ app.add_middleware(
441441

442442
### Allowed Hosts
443443

444-
This middleware prevents HTTP Host Headers attack, you shoud put here you server IP or (preferably) full domain under it's accessible like `example.com`. By default `"localhost", "127.0.0.1", "0.0.0.0"`
444+
This middleware prevents HTTP Host Headers attack, you should put here your server IP or (preferably) full domain under which it's accessible like `example.com`. By default `"localhost", "127.0.0.1", "0.0.0.0"`
445445

446446
```python
447447
app.add_middleware(TrustedHostMiddleware, allowed_hosts=config.settings.ALLOWED_HOSTS)

0 commit comments

Comments
 (0)