This project is only the client part of the app available on public url "TBD". Thi project was bootstrapped with Create React App. Refer to the "package.json" file on the root of the app to know details about the packages and dependencies.

Data Source

APIs are a not a part of this project. This project relies on an open source project to maintain the APIs used across the app. Link to APIs Project

Available Scripts

In the project directory, you can run:

npm start

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

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build 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 deployment for more information.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Contributing

If you're new to contributing to Open Source, this guide can help you get started. Please check out the contribution guide for more details on how issues and pull requests work.

Contributing Guidelines

First off, thanks for taking the time to contribute! 😄

Contributions are handled in the form of Pull Requests. You fork this repository, create a new branch, make relevant changes, and submit a Pull Request – once that's done we'll be able to review your PRs and merge them to the master branch.

Always submit a PR against a "Claimed Issue" that's been assigned to you. If an issue doesn't exist, please raise one first and wait for it to be labelled as "Available", and then have it assigned to you. PRs without having accepted issues mentioned will be closed.

Process Flow

• When a new issue is created, "Status: Review Needed" and "Type: Bug"or "Type: Enhancement" label will be added to it
• Contributors should periodically check for "Status: Review Needed" and add appropriate Priority and Status labels if and when needed
• If the issue is clear, set the status label as "Status: Available"
• People looking to contribute, filter issues by "Status:Available" and comment "/claim" on the issue they would like to be assigned to work on
• Finally submit the pull request

Formatting

Format your PR titles likewise:

[Tag]: Describe change in present tense

Tag can be:

• Feat (new feature)
• Fix (bug fix)
• Refactor (refactoring code)
• Style (formatting, no code change)
• Doc (changes to documentation)
• Test (adding or refactoring tests; no production code change)

Remember to:

• Capitalize the subject line
• Use the imperative mood in the subject line