NaviCourse

A project by Coding Hub

NaviCourse is a web app that helps student rate courses and decide on which courses to take.

Getting Started

These are instructions on how to run our website locally on your machine.

Prerequisites

Before you begin, you should have Node.js and yarn 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 - Backend Framework
• Yarn - Dependency Management