- Fork this repo and clone it locally. Click here to fork this repo.
- Fix the issue
- Create Pull Request to this repository
Before you can begin, you will need git, node, and a text editor.
If you are running Windows, we recommend you install and use Windows Subsystem for Linux. From your WSL terminal, follow the linux instructions linked below.
-
If you haven't already, ensure that your development environment is set up properly. Refer to the section above for tips.
-
Fork this repository to your Github account.
-
Clone the repository to your local environment.
- In Terminal, go to the folder where you would like to clone the repository to.
- Get a link to the repository as image below shows:
- Run
git clone {link_to_repository}
-
Go into the repository. In Unix environment you can use
cd
command for this. -
Install dependencies frontend app needs to run. Run:
npm install
Note that you might need sudo permissions for that.
- Start backend. Run:
npm run start-json-server
- Start frontend. Run:
npm run start
- If you haven't already, ensure that your app runs locally successfully. Refer to the section above for tips.
- Go to
Issues
tab in the repository and pick an issue. If you are just getting started, consider picking one of the issues that are marked asEasy
. - Thoroughly read issue description and make sure you understand it.
- Before writing/modifying any code, create a new branch in your local git. This is best practice in the industry - to create a separate branch for each issue you are working on.
This project was built using
- Vanilla Javascript
- HTML
- CSS
- Webpack
Create and submit a pull request to this repository. We personally review each pull request and share our feedback.
The best way is to ask a question in our Discord community. Please consider joining: https://discord.gg/7cAkUcKbjB