forked from developer-job-simulation/javascript-crm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Dmitrii Belousov
committed
Apr 29, 2022
1 parent
8f43e5d
commit 530efd9
Showing
2 changed files
with
32 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,45 @@ | ||
### How to get started? | ||
### How to setup your development environment? | ||
- TODO how to install git, node/npm, vscode. | ||
- TODO how to configure ssh for github | ||
- 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. | ||
|
||
1. Install dependencies frontend app needs to run. Run: | ||
### How to launch the app locally? | ||
1. If you haven't already, ensure that your development environment is set up properly. Refer to the section above for tips. | ||
2. Clone the repository to your local environment. | ||
1. In Terminal, go to the folder where you would like to clone the repository to. | ||
2. Get a link to the repository as image below shows: | ||
 | ||
3. Run | ||
```bash | ||
git clone {link_to_repository} | ||
``` | ||
|
||
3. Go into the repository. In Unix environment you can use `cd` command for this. | ||
4. Install dependencies frontend app needs to run. Run: | ||
```bash | ||
npm install | ||
``` | ||
|
||
Note that you might need sudo permissions for that. | ||
|
||
2. Start backend. Run: | ||
3. Start backend. Run: | ||
```bash | ||
npm run start-json-server | ||
``` | ||
|
||
4. Start frontend. Run: | ||
```bash | ||
npm run start | ||
``` | ||
``` | ||
|
||
### How to start working on an issue? | ||
|
||
1. If you haven't already, ensure that your app runs locally successfully. Refer to the section above for tips. | ||
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`. | ||
3. Thoroughly read issue description and make sure you understand it. | ||
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. | ||
|
||
### How to get help? | ||
|
||
The best way is to ask a question in our Discord community. | ||
Please consider joining: https://discord.gg/7cAkUcKbjB |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters