This is build on python 3.8.12. Recommend python version: 3.7 and beyond
-
make sure: a. you have pip installed, which manages python libraries for you; b. this is built on 3.8.12, so I recommind python version 3.7 and beyond c. main.py make connection to a cloud mongo db, so make sure you have internet connection as well LET ME KNOW if you cannot connect to the cloud db, I will have to fix the config for this db
-
install all dependencies: pip install -r requirements.txt
-
Run main.py on the first terminal: python main.py
-
Poppulate Data into MongoDB You DON'T have to populate the same data multiple times use this on a new terminal: http POST http://127.0.0.1:5000/api/db_populate
-
test get api_addresses() http GET http://127.0.0.1:5000/api/address
-
test get api_address_by_state http GET http://127.0.0.1:5000/api/address/WA
-
test other methods You get the idea, this is how you write any test command on shell/cmd: http
MAKE SURE: you test these API call on the second terminal/cmd while running main.py on the first terminal/cmd.