Arcade Mode is an interview preparation app featuring algorithm and data structure questions in a timed environment.
Arcade Mode has been undergoing heavy prototyping and iteration. As such, it is currently set up with development and debugging in mind.
- Fork the repository using the "Fork Button" in the upper right hand corner of the interface.
- Clone your fork using
git clone https://github.com/<YOUR_GITHUB_USERNAME>/arcade-mode.git
into your projects directory (e.g.,/<YOUR_PROJECTS_DIRECTORY>/
- Go into the new arcade-mode directory.
- Run
npm install
to install dependencies and start the build process. - Run
npm start
and see the example app at http://localhost:8080
- Find an issue that needs assistance by searching for the Help Wanted tag.
- After finishing Quick Start steps 1 - 4, do the following.
- Set the upstream remote to the official arcade-mode repository:
git remote add upstream https://github.com/freeCodeCamp/arcade-mode.git
- Always make modifications on a branch. Make a branch using:
git checkout -b <BRANCH_NAME>
. - Before submitting a pull request, make sure to test the modifications using
npm run test:client
. - To maintain and keep the fork up to date, make sure to update the fork with the upstream remote occassionally with:
git merge upstream master
.
For a more complete guide, see CONTRIBUTING.md.