Skip to content

Update README with project setup instructions #961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 19, 2020
Merged

Update README with project setup instructions #961

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,30 @@ The public facing website for BrickHack.

# Getting Started
Copy link
Contributor

@peterkos peterkos Sep 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to go for maximum Cool README I'd suggest putting a screenshot of the preregister site right at the top! See the brickhack-mobile-ios readme for how I centered that image if you'd like.

Copy link
Member Author

@ww3637 ww3637 Sep 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like that might be a little less relevant for this since it's a website you can easily visit.


#### Code environment
## Code environment
Copy link
Contributor

@peterkos peterkos Sep 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Title not needed imo, description is clear as-is


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.
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.

### Cloning the directory

```bash
$ git clone git@github.com:codeRIT/brickhack.io.git
$ git clone https://github.com/codeRIT/brickhack.io.git
$ cd brickhack.io
```

You should then be able to open the code in your editor of choice.
### Installing dependencies

```
$ npm install
```

### Running the application

```
$ npm start
```

You should then be able to access the site at `localhost:3000`.

# Development & Deployment

Expand Down