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
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,23 +13,27 @@ This project is written in `Python 3.12.1`
13
13
```bash
14
14
pip install -r requirements.txt
15
15
```
16
-
16
+
`requirements.txt` contains an adapter for PostgreSQL by default.
17
17
18
18
### Usage
19
19
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.
23
21
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:
25
23
26
24
```bash
27
25
flask --app app shell
28
26
>>> with app.app_context():
29
27
>>> db.create_all()
30
28
```
31
29
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.
0 commit comments