Skip to content

Commit a61b19f

Browse files
update README with db config details
1 parent d930e7b commit a61b19f

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,27 @@ This project is written in `Python 3.12.1`
1313
```bash
1414
pip install -r requirements.txt
1515
```
16-
16+
`requirements.txt` contains an adapter for PostgreSQL by default.
1717

1818
### Usage
1919

20-
Start the server:
21-
22-
`flask --app app run [--debug]` (Starts the server on 127.0.0.1:5000)
20+
Copy `.env.example` and rename to `.env`. Provide your database URL to the `SQLALCHEMY_DATABASE_URI` environment variable.
2321

24-
This project is preloaded with a dummy `sqlite` database located in the `instance` directory. To start from a scratch db, delete the `instance` directory and:
22+
Create database tables:
2523

2624
```bash
2725
flask --app app shell
2826
>>> with app.app_context():
2927
>>> db.create_all()
3028
```
3129

32-
To test the API using Postman, install postman agent in your OS and call the API using Postman.
30+
Start the server: (Runs on 127.0.0.1:5000)
31+
32+
```bash
33+
flask --app app run [--debug]
34+
```
35+
36+
Test the API using Postman, cURL or your preferred HTTP client.
3337

3438
### Endpoints
3539

0 commit comments

Comments
 (0)