We want to make contributing to this project as easy and transparent as possible.
Get started by cloning this repository and and running npm install inside it. Update parse-dashboard-config.json in the Parse-Dashboard folder inside the repo, using the format described in the README.md.
When working on the dashboard, use npm run dashboard and visit localhost:4040 to see your dashboard. The npm run dashboard script will automatically re-build your files when you change them, so after making a change, all you need to do is refresh the page.
When working on React components, use npm run pig and visit localhost:4041 to view our component library and documentation (you can have both Dashboard and PIG running at once). The demos for each component are the primary way we test components, although there are also a small number of automated tests you can run with npm test. If you would like to create a new component that does not exist in the component library, use npm run generate yourComponentName to generate boilerplate code and quickly get started.
We actively welcome your pull requests.
- Fork the repo and create your branch from the
alphabranch. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- If you've updated/added an UI component, please add a screenshot.
- If you've fixed an issue or added features, add what you've changed to the CHANGELOG.
- Ensure the test suite passes.
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to Servable Dashboard, you agree that your contributions will be licensed under its license.