Skip to content

Commit f96e1dd

Browse files
committed
update readme πŸ“
1 parent 871d410 commit f96e1dd

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,25 @@ cp .env.example .env
6262
# Edit .env with your database credentials
6363
```
6464

65+
> πŸ’‘ **Important**:
66+
> - The DATABASE_URL must start with `postgresql+asyncpg://` (e.g., `postgresql+asyncpg://user:pass@localhost:5432/dbname`)
67+
> - After updating environment variables, close and reopen VS Code to reload the configuration properly. VS Code will automatically activate the virtual environment when you reopen.
68+
6569
5. Start the application:
70+
71+
Using terminal:
72+
```bash
73+
uv run uvicorn api.main:app
74+
```
75+
76+
Using VS Code:
77+
> πŸ’‘ If you're using VS Code, we've included run configurations in the `.vscode` folder. Just press `F5` or use the "Run and Debug" panel to start the application!
78+
79+
6. (Optional) Enable pre-commit hooks for linting:
6680
```bash
67-
uv run uvicorn app.main:app
81+
uv run pre-commit install
6882
```
83+
> πŸ’‘ This will enable automatic code formatting and linting checks before each commit
6984
7085
## Creating a Migration πŸ”„
7186
1. Make changes to your models

0 commit comments

Comments
Β (0)