Skip to content

Commit c49ece6

Browse files
authored
Merge pull request #961 from codeRIT/issue-960
Update README with project setup instructions
2 parents 2e90a37 + b5f1ba9 commit c49ece6

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,30 @@ The public facing website for BrickHack.
88

99
# Getting Started
1010

11-
#### Code environment
11+
## Code environment
1212

13-
Ensure you have Git set up and [SSH access to GitHub](https://help.github.com/articles/connecting-to-github-with-ssh/). If you have Git but not SSH, you can clone using the HTTPS url, however you'll have to type in your GitHub credentials every time.
13+
Ensure you have Git set up and [SSH access to GitHub](https://help.github.com/articles/connecting-to-github-with-ssh/). If you have Git but not SSH, you can clone using the HTTPS url, but you'll have to type in your GitHub credentials every time.
14+
15+
### Cloning the directory
1416

1517
```bash
16-
$ git clone git@github.com:codeRIT/brickhack.io.git
18+
$ git clone https://github.com/codeRIT/brickhack.io.git
1719
$ cd brickhack.io
1820
```
1921

20-
You should then be able to open the code in your editor of choice.
22+
### Installing dependencies
23+
24+
```
25+
$ npm install
26+
```
27+
28+
### Running the application
29+
30+
```
31+
$ npm start
32+
```
33+
34+
You should then be able to access the site at `localhost:3000`.
2135

2236
# Development & Deployment
2337

0 commit comments

Comments
 (0)