You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,10 +62,25 @@ cp .env.example .env
62
62
# Edit .env with your database credentials
63
63
```
64
64
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
+
65
69
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:
66
80
```bash
67
-
uv run uvicorn app.main:app
81
+
uv run pre-commit install
68
82
```
83
+
> π‘ This will enable automatic code formatting and linting checks before each commit
0 commit comments