Skip to content

Commit

Permalink
chore: updating READMEs (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
hurshd0 committed Apr 14, 2020
1 parent 52554b4 commit 979ff02
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,44 @@

[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

[<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/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

[<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
[<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

---

## 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.

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
```

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.

### Issue/Bug Request
Expand Down

0 comments on commit 979ff02

Please sign in to comment.