From b5f1ba960eeac5fda9687293f511abb6755b3034 Mon Sep 17 00:00:00 2001 From: ww2497 Date: Thu, 17 Sep 2020 21:13:10 -0400 Subject: [PATCH] Basic build instructions --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 34f44f455..b9bc79eb5 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,30 @@ The public facing website for BrickHack. # Getting Started -#### Code environment +## Code environment -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