Skip to content

Commit 5d9b25b

Browse files
authored
Merge branch 'develop' into issue-953
2 parents 2e5e352 + c49ece6 commit 5d9b25b

2 files changed

Lines changed: 19 additions & 5 deletions

File tree

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

public/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8"/>
5-
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"/>
66
<meta name="keywords" content="hackathons, hackathon, hack-a-thon, programming, hardware, development, design, rit"/>
77
<meta name="theme-color" content="#000000"/>
88

0 commit comments

Comments
 (0)