Trontor / lookahead

A semester planner for students at The University of Melbourne.
https://lookahead.rohyl.io/
MIT License
28 stars 9 forks source link

Lookahead | UoM Semester Planner

Lookahead is an online application that allows students at the University of Melbourne to plan their semester. A variety of customisations and optimisations are provided to help students make the most out of their semester.

Features

Published at: https://lookahead.rohyl.io/

Installation Instructions

This project has been built in React frontend with a Node backend written in Typescript. This means that to get this running locally, you will have to run two installation scripts. You must have Node.js and consequentially npm installed.

Yarn Package Manager Installation

In your terminal, run:

npm install --global yarn

Typescript Dependency Installation

In any folder, issue the following command:

yarn add typescript

Node.js Dependency Installation

In the root folder, issue the following installation command:

yarn install

This should install a number of dependencies and development dependencies to a folder called node_modules, where your packages live.

React JS Dependency Installation

Now, go into the client folder and issue the same command. Like so:

cd client
yarn install

This should create a node_modules folder within the client folder.

Running Locally

In the root folder run

yarn run dev

To concurrently boot the backend server and front-end. This might take a while, but should eventually work. If there is some error you can't overcome, just reach out to me or a friend who knows JS.