chore: updating readmes (#49)

* refactor: change Aaron to standard feat: adding basic test
- Changed APP to app according to Flask/FastAPI standard
- Changed config_ to _config. trailing space is for python default conflicts not import
- Adding basic tests for endpoints

* test: added test structures
- 	est_app.py: testing �pp.py app title, description, version
- 	est_config.py: tested ProductionConfig, DevelopmentConfig, config loader
- 	est_endpoints.py: tested root test

* test: added test structures
- 	est_app.py: testing �pp.py app title, description, version
- 	est_config.py: tested ProductionConfig, DevelopmentConfig, config loader
- 	est_endpoints.py: tested root test

* tests: add testing for custom error messages

* chore: updated README

* chore: fixed PR template

* chore: updated README

* chore: updated README

* tests: adds test cases for endpoints
- '/' done
- '/news' only testing for 422 and 405, no validation yet
- '/twitter': tested 422, 404, 405, and random data sample validation
- '/county': tested 404, 405, 422. no data return validation yet
- '/state': tested 405, 422.
- '/country': tested 405, 422.
- '/stats': tested 405, 422.

* style: fix for codefactor.
- 	est_config.py: keeping assert == True/False for code readability
- 	est_endpoints.py: keeping TODO as a reminder to fix endpoints.py

* style: changed config_ to �pp_config after technical discussion

* style: chore:
- added .pylintrc
- fixed all files for pylint
- added .github/workflow/pythonapp.yml
- added pipenv, pylint and pytest

* chore:
- streamlining pythonapp.yml
- triggers pythonapp.yml on all push and pull_request

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml, readme.md

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* chore: updated pythonapp.yml

* feat: rerouting root endpoint to postman

* feat: rerouting root endpoint to postman

* feat: added redirect to postman, added test

* fix: added uvloop

* feat: adding coverall

* feat: installed coveralls for coverall.io

* feat: installed coveralls for coverall.io

* feat: installed coveralls for coverall.io

* feat: installed coveralls for coverall.io attempt 6

* feat: installed coveralls for coverall.io attempt 8

* feat: installed coveralls for coverall.io attempt 9

* feat: settingup coverall attempt #11

* feat: coverall badge attempt #12

* feat: coverall added, feat: routing root to redoc

* fix: default config logic

* fix: default config logic

* Update LICENSE

* chore: updating README again  🤧 (#46)

* chore: updating READMEs

* chore: updating READMEs

* chore: updating READMEs (#48)

Co-authored-by: leehanchung <[email protected]>

LICENSE

@@ -631,7 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
- US Specific Coronavirus Dashboard's API, used for tracking current cases by county, state, COVID-19, hospital bed info, twitter feed, and news feed.
+ US Specific Coronavirus Dashboard's API, used for tracking current 
+ cases by county, state, COVID-19, hospital bed info, twitter feed, and news feed.
  Copyright (C) 2020 ncov19us
 
  This program is free software: you can redistribute it and/or modify

README.md

@@ -9,8 +9,6 @@
 
 #### Backend delpoyed at 👉 [Public API](https://api.ncov19.us/) <br>
 
-#### Backend delpoyed at 👉 [api.ncov19.us](https://api.ncov19.us) <br>
-
 ## 1️⃣ Endpoints
 
 #### Main Routes
@@ -30,27 +28,43 @@
 
 [API Doc Swagger](https://api.ncov19.us/docs)
 
-## 2️⃣ Getting started
+## 2️⃣ Tech Stack 📚 
 
-- FastAPI
-- PyMongo
+- [FastAPI](https://fastapi.tiangolo.com/)
+- [PyMongo](https://api.mongodb.com/python/current/)
 
----
+## 3️⃣ Contributors
 
-## 4️⃣ Contributors
+[<img src="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/favicon.ico" width="20"> ](https://github.com/leehanchung) [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="20"> ](https://www.linkedin.com/in/hanchunglee/) [<img src="https://twitter.com/favicon.ico" width="20">](https://twitter.com/hanchunglee) **[Han Lee](https://github.com/leehanchung)** | Maintainer & Project Lead
 
-### Project Leaders
+[<img src="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/favicon.ico" width="20"> ](https://github.com/hurshd0) [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="20"> ](https://www.linkedin.com/in/hurshd/) [<img src="https://twitter.com/favicon.ico" width="20">](https://twitter.com/hurshd0) **[Hursh Desai](https://hurshdesai.com/)** | Maintainer & Project Lead
 
-[<img src="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/favicon.ico" width="20"> ](https://github.com/leehanchung) [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="20"> ](https://www.linkedin.com/in/hanchunglee/) [<img src="https://twitter.com/favicon.ico" width="20">](https://twitter.com/hanchunglee) **[Han Lee](https://github.com/leehanchung)** | Maintainer
+---
 
-[<img src="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/favicon.ico" width="20"> ](https://github.com/hurshd0) [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="20"> ](https://www.linkedin.com/in/hurshd/) [<img src="https://twitter.com/favicon.ico" width="20">](https://twitter.com/hurshd0) **[Hursh Desai](https://github.com/hurshd0)** | Maintainer
+## 4️⃣ Contributing
 
----
+### Git Workflow 
+
+- Our commits use a style called **[semantic commits](https://seesparkbox.com/foundry/semantic_commit_messages)**. 
+- Pick a task to work on from the Github issues or Trello board, assign your name to it via the top right of the Trello card, and confirm that no one is already working on this task, or another task that is likely to cause merge issues with yours.
 
+```sh
+git clone https://github.com/ncov19-us/ncov19-vacc-dash-front-end.git
+git checkout staging
+git checkout -b <your-feature-branch>
+```
+Commit your work using semantic commits structure.
 
-## 3️⃣ Contributing
+When done:
+```sh
+git checkout staging
+git pull # sync your local feature branch with origin/github
+git checkout <your-feature-branch>
+git rebase staging # merge your branch w/ feature-branch
+git commit
+```
 
-When contributing to this repository, please read [CONTRUBTION](./CONTRIBUTION.md) guide.
+Push your branch: `git push origin <your-feature-branch>`. Then open a pull request from your working branch into `staging` for review.
 
 Please note we have a [CODE OF CONDUCT](./CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project.