Skip to content

Commit 376a4b6

Browse files
committed
chore: update readme
1 parent becf7ad commit 376a4b6

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed

.idea/workspace.xml

Lines changed: 21 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Employee Management API
2+
![pylint workflow](https://github.com/volt1c/employee_management_api/actions/workflows/pylint.yml/badge.svg)
3+
14
## Instruction
25

36
### 1. Install Packages
@@ -11,10 +14,20 @@ $ pip install -r requirements.txt
1114
Set your database URI and jwt secret key
1215
```dotenv
1316
# .env
17+
# Host Config
18+
HOST='0.0.0.0'
19+
PORT=80
20+
ENV='production'
21+
DEBUG=False
22+
23+
# Database Config
1424
SQLALCHEMY_DATABASE_URI_DEV='mysql://username:password@address/database_name'
1525
SQLALCHEMY_TRACK_MODIFICATIONS=False
26+
27+
# Auth Config
1628
JWT_SECRET_KEY='some_jwt_secret_key'
17-
JSON_SORT_KEYS=False
29+
30+
# Routes Config
1831
ROUTE_ADMIN_REGISTRATION=True
1932
```
2033

0 commit comments

Comments
 (0)