This is an open source project created to allow our apprentice developers, and others to learn and practice. It is an informational website that directs users to our in-person and virtual hackathons.
We hope you will participate in making this project great, and we look forward to seeing you at the next hackathon!
Here's the deployed project
Please read the Contribution Guidelines before opening a pull request.
We recommend installing NVM. It makes it much easier to switch node versions when working on multiple projects.
nvm install will install the correct version of node required for the project.
If you don't use nvm, you can install node yourself.
nvm use will switch to the correct version of node required for the project.
https://classic.yarnpkg.com/en/docs/install/
yarn install
yarn dev
Try to use MUI components whenever posssible.
We use:
All tests must pass before a PR will be accepted.
yarn testwill run the test suite.
We use:
All lint must be removed, and the code must be formatted correctly before a PR will be accepted.
yarn lintwill run the JavaScript linter.yarn stylelintwill run the css linter.yarn prettierwill run the formatter.
We use:
This repository has a pre-commit hook that will attempt to correct any linting and formatting issues. If there are any files that still contain lint after running the pre-commit hook, the commit will fail, and you will have to manually correct the issues.
Pull requests are welcome from anyone. Please follow the documentation provided to ensure your pull request is accepted.
We want to improve this project, so if you find an issue, or if you have a suggestion for improvement, search the existing issues section, and if an issue doesn't already exist, open a new issue.
