Added proper README

README.md

@@ -1,7 +1,47 @@
-# NAVICOURSE
+# NaviCourse
 
-A web application to rate courses on campus. The application's purpose is to help students identify which courses they want to take and which professors they can take it with.
+### A project by [![N|Solid](https://avatars3.githubusercontent.com/u/43360008?s=40&v=4)](https://www.coding-hub.com/) Coding Hub
+
+NaviCourse is a web app that helps student rate courses and decide on which courses to take.
 
-## Steps to Run Application
+## Getting Started
 
-This is a web application built on HTML, CSS, vanilla JS for the frontend and ExpressJS for the backend.
+These are instructions on how to run our website locally on your machine.
+
+### Prerequisites
+
+Before you begin, you should have [Node.js](https://nodejs.org/en/ "Node JS HomePage") and [yarn](https://yarnpkg.com/en/ "Yarn HomePage") installed. If you do not have them installed, you can install them from the links or using the commands provided below (the commands do not work in all operating systems).
+
+* Node JS
+    - https://nodejs.org
+* Yarn
+    - https://yarnpkg.com
+    - `curl -o- -L https://yarnpkg.com/install.sh | bash`
+* git
+    - https://git-scm.com/downloads
+
+### Installing Modules/Dependencies
+You can clone the repository using the following command:
+`git clone https://github.com/coding-hub-org/coding-hub-website.git`
+
+And install the necessary dependencies using the following commands inside the project folder:
+```
+yarn install
+```
+
+### Running the Website
+After installing the dependencies, from the root directory of the project, run this command in the terminal.
+`yarn start:backend`
+And in another terminal run:
+`yarn start:frontend`
+
+
+## Running the Tests
+We do not have set any testing frameworks yet.
+
+## Deployment
+Our site is automatically deployed to our hosting service. Any changes made to the master branch of this repository will be automatically deployed to show in production.
+
+## Built With
+* [Express](https://expressjs.com) - Backend Framework
+* [Yarn](https://yarnpkg.com/) - Dependency Management

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "install:frontend": "cd ./packages && cd ./frontend && yarn",
     "install:backend": "cd ./packages && cd ./backend && yarn",
+    "install": "yarn install:frontend && yarn install:backend",
     "start:frontend": "cd ./packages && cd ./frontend && yarn dev",
     "start:backend": "cd ./packages && cd ./backend && yarn start"
   },

yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+