Skip to content

Commit 7b03b99

Browse files
committed
docs: running info and features list added
1 parent 32e6302 commit 7b03b99

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
11
# SQL Boilerplate
2-
A simple FastAPI application with raw SQL queries using `psycopg2`. The database connection is made using an `Database` abstract class, so it is possible to change drivers without much trouble.
2+
A simple FastAPI application with raw SQL queries using context managers and injecting the SQL driver module.
3+
4+
The database connection is made using an `Database` abstract context manager, so it is possible to change drivers without much trouble.
35

46
### Requirements
57
- Python 3.13+
6-
- [uv](https://github.com/astral-sh/uv)
8+
- [uv](https://github.com/astral-sh/uv)
9+
10+
### Running Project
11+
Default values for the `.env` files are already set in the dev compose.
12+
```bash
13+
docker compose -f compose.dev.yaml up --build -d
14+
```
15+
16+
### Swagger
17+
Access swagger at `localhost:8000/docs`.
18+
19+
Mocked user
20+
email: admin@email.com
21+
password: 1234
22+
23+
### Project Features
24+
- Authentication with JWT and OAuth2
25+
- Permission management with rules table
26+
- Testing pipeline with Github Actions + Docker
27+
- Unit tests with Pytest
28+
- Pagination module
29+
- Schema creation with Pydantic

0 commit comments

Comments
 (0)