-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
42 changed files
with
1,161 additions
and
267 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
REACT_APP_MAPBOX_ACCESS_TOKEN=<mapbox_access_token> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
# Contribution Guide | ||
|
||
<details> | ||
<summary>Issues</summary> | ||
<ul> | ||
<li> | ||
Make sure that there are no duplicate issues by first checking the | ||
<a | ||
href="https://github.com/stephin007/Cowin-Vaccine-Availablity-Checker/issues" | ||
>Issues</a | ||
> | ||
tab and that the issue that you've selected hasn't already been assigned or | ||
being worked on. | ||
</li> | ||
<li> | ||
The title should follow the following pattern: | ||
<code>[TYPE] <short-description></code>, where <code>TYPE</code> is one | ||
of <code>feat</code> | <code>fix</code> | <code>docs</code> | | ||
<code>build</code> | <code>ci/cd</code> | ||
</li> | ||
<li> | ||
Explain, in detail, what the issue is about and if it's a bug, add steps to | ||
reproduce it. | ||
</li> | ||
</ul> | ||
</details> | ||
|
||
<details> | ||
<summary>Branching</summary> | ||
<ul> | ||
<li> | ||
When creating branches, please use the following pattern: | ||
<code>type/issue-{issue-number}</code> (f.eg.: <code>feat/issue-12</code>, | ||
<code>fix/issue-87</code>) | ||
</li> | ||
</ul> | ||
</details> | ||
|
||
<details> | ||
<summary>Project Setup</summary> | ||
<ul> | ||
<li> | ||
Fork this repo and then clone the forked repo | ||
(<code>https://github.com/<your-username>/Cowin-Vaccine-Availablity-Checker.git</code>) | ||
</li> | ||
<li> | ||
Run either <code>yarn</code> or <code>npm install</code> inside the root | ||
directory to install all the required dependencies(Please make sure to | ||
remove duplicate/redundant lockfiles) | ||
</li> | ||
<li> | ||
Scripts | ||
<ul> | ||
<li> | ||
<code>start</code>: Run the app in the development mode. Open | ||
http://localhost:3000 to view it in the browser. The page will reload | ||
if you make edits. You will also see any lint errors in the console. | ||
</li> | ||
<li> | ||
<code>build</code>: Builds the app for production to the | ||
<code>build</code> folder. It correctly bundles React in production | ||
mode and optimizes the build for the best performance. The build is | ||
minified and the filenames include the hashes. Your app is ready to be | ||
deployed! See the section about | ||
<a href="https://facebook.github.io/create-react-app/docs/deployment" | ||
>deployment</a | ||
> | ||
for more information. | ||
</li> | ||
<li> | ||
<code>eject</code>: <br /><i | ||
>Note: this is a one-way operation. Once you <code>eject</code>, you | ||
can’t go back!</i | ||
><br />If you aren’t satisfied with the build tool and configuration | ||
choices, you can `eject` at any time. This command will remove the | ||
single build dependency from your project. Instead, it will copy all | ||
the configuration files and the transitive dependencies (webpack, | ||
Babel, ESLint, etc) right into your project so you have full control | ||
over them. All of the commands except `eject` will still work, but | ||
they will point to the copied scripts so you can tweak them. At this | ||
point you’re on your own. You don’t have to ever use `eject`. The | ||
curated feature set is suitable for small and middle deployments, and | ||
you shouldn’t feel obligated to use this feature. However we | ||
understand that this tool wouldn’t be useful if you couldn’t customize | ||
it when you are ready for it. | ||
</li> | ||
<li><code>test</code>: Run tests using Jest</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</details> | ||
|
||
<details> | ||
<summary>Environment Variables</summary> | ||
<ul> | ||
<li> | ||
<strong>REACT_APP_MAPBOX_ACCESS_TOKEN: TO add this token , Make sure you dont delete the .env.example but make a copy and paste the it the root directory and rename it to .env and paste your token which you will get as you follow the below steps.</strong> | ||
<ul> | ||
<li> | ||
Create a MapBox account by navigating to | ||
<a href="https://account.mapbox.com/auth/signup">this link</a> | ||
<img | ||
src="https://user-images.githubusercontent.com/66718300/119947085-fc216e80-bfb4-11eb-9d49-322a3343d2b8.png" | ||
alt="image" | ||
/> | ||
</li> | ||
<li> | ||
After creating and verifying the account, go to | ||
<a href="https://accoung.mapbox.com">https://accoung.mapbox.com</a> | ||
and copy the access token | ||
<img | ||
src="https://user-images.githubusercontent.com/66718300/119947810-c761e700-bfb5-11eb-8e32-23d1a535894f.png" | ||
alt="Screenshot from 2021-05-28 13-03-08" | ||
/> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
> 🚨 Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository. | ||
### Please check if the PR fulfills these requirements | ||
|
||
- [ ] Make sure you are requesting to **NEW-UI**. Don't request other protected Branches like **staging/master** | ||
- [ ] Make sure no conflicts are present in the code, if so please resolve it(_Tip: Always fetch upstream_) | ||
- [ ] Your Commit messages should make sense. | ||
- [ ] Don't push your package.lock.json as this project uses yarn.lock already. | ||
- [ ] Check your code additions will fail neither code linting checks nor unit test. | ||
|
||
### Describe your changes | ||
|
||
- **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) | ||
|
||
- **What is the current behavior?** (You can also link to an open issue here) | ||
|
||
- **What is the new behavior (if this is a feature change)?** | ||
|
||
- **Does this PR introduce a breaking change?** (i.e changes that may require users to update/refactor existing istances of the application) | ||
|
||
- **Other Information**: | ||
|
||
❤️ Thank you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.