|
1 |
| -### How to get started? |
| 1 | +### How to setup your development environment? |
| 2 | +- TODO how to install git, node/npm, vscode. |
| 3 | +- TODO how to configure ssh for github |
| 4 | +- TODO What if they are on Windows? If Windows is Professional edition, they should install and use `wsl2`. If they are on Home edition, they can't use `wsl2` and they are f*ed. |
2 | 5 |
|
3 |
| -1. Install dependencies frontend app needs to run. Run: |
| 6 | +### How to launch the app locally? |
| 7 | +1. If you haven't already, ensure that your development environment is set up properly. Refer to the section above for tips. |
| 8 | +2. Clone the repository to your local environment. |
| 9 | + 1. In Terminal, go to the folder where you would like to clone the repository to. |
| 10 | + 2. Get a link to the repository as image below shows: |
| 11 | +  |
| 12 | + 3. Run |
| 13 | + ```bash |
| 14 | + git clone {link_to_repository} |
| 15 | + ``` |
| 16 | + |
| 17 | +3. Go into the repository. In Unix environment you can use `cd` command for this. |
| 18 | +4. Install dependencies frontend app needs to run. Run: |
4 | 19 | ```bash
|
5 | 20 | npm install
|
6 | 21 | ```
|
7 | 22 |
|
8 | 23 | Note that you might need sudo permissions for that.
|
9 | 24 |
|
10 |
| -2. Start backend. Run: |
| 25 | +3. Start backend. Run: |
11 | 26 | ```bash
|
12 | 27 | npm run start-json-server
|
13 | 28 | ```
|
14 | 29 |
|
15 | 30 | 4. Start frontend. Run:
|
16 | 31 | ```bash
|
17 | 32 | npm run start
|
18 |
| -``` |
| 33 | +``` |
| 34 | + |
| 35 | +### How to start working on an issue? |
| 36 | + |
| 37 | +1. If you haven't already, ensure that your app runs locally successfully. Refer to the section above for tips. |
| 38 | +2. 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 as `Easy`. |
| 39 | +3. Thoroughly read issue description and make sure you understand it. |
| 40 | +4. 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. |
| 41 | + |
| 42 | +### How to get help? |
| 43 | + |
| 44 | +The best way is to ask a question in our Discord community. |
| 45 | +Please consider joining: https://discord.gg/7cAkUcKbjB |
0 commit comments