Skip to content

Commit cd204ab

Browse files
committed
docs: new features
1 parent 1a0f3fd commit cd204ab

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@ This is a ready-to-use project template for building FastAPI applications with M
1919
## Features
2020

2121
- JWT-based authentication.
22+
- Refresh token.
23+
- Tests with pytest.
24+
- Log handler.
25+
- Add indexes to MongoDB.
2226

2327
## Roadmap
2428

2529
- Email verification.
26-
- Refresh token.
27-
- Tests with pytest.
2830
- Handler exceptions.
29-
- Log handler.
3031

3132
## :hammer_and_wrench: Stack
3233
- [![Python][python-badge]][python-url] - Programming language.
@@ -62,10 +63,24 @@ Run the Docker container:
6263
docker compose up -d
6364
```
6465

65-
The application will be available at `http://localhost:8000`.
66+
The application will be available at `http://localhost:8000/api/v1/docs`.
6667

6768
The mongo-express UI will be available at `http://localhost:8081`.
6869

70+
## :test_tube: Test
71+
72+
> [!WARNING]
73+
> When run the tests, the database is cleaned.
74+
75+
To test the application, access to the fastapi container:
76+
```sh
77+
docker exec -it fastapi-mongodb sh
78+
```
79+
Finally, execute:
80+
```sh
81+
uv run pytest
82+
```
83+
6984
## Contributors <!-- omit in toc -->
7085

7186
<a href="https://github.com/CarlosAndreo/fastapi-mongodb/graphs/contributors">

0 commit comments

Comments
 (0)