Skip to content

Commit 530efd9

Browse files
author
Dmitrii Belousov
committed
Updated readme
1 parent 8f43e5d commit 530efd9

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,45 @@
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.
25

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+
![alt text](https://i.imgur.com/ZPYKL1y.png)
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:
419
```bash
520
npm install
621
```
722

823
Note that you might need sudo permissions for that.
924

10-
2. Start backend. Run:
25+
3. Start backend. Run:
1126
```bash
1227
npm run start-json-server
1328
```
1429

1530
4. Start frontend. Run:
1631
```bash
1732
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

src/constants.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
export const BACKEND_BASE_URI = "http://localhost:3000";
66
export const COMPANIES_API_PATH = "/companies";
77

8-
export const COMPANIES_TABLE_HEADERS = ["Company Name", "Status", "Created At", "Account Executive", "Revenue YTD"];
8+
export const COMPANIES_TABLE_HEADERS = ["Company Name", "Status", "Created At", "Revenue YTD", "Account Executive"];
99

1010
export const COMPANY_NAME_FIELD_NAME = "company_name";
1111
export const STATUS_FIELD_NAME = "status";

0 commit comments

Comments
 (0)