In this project, we aim to build a web-based application for SMU students to be able to plan their school modules and have a clear visual to their planned timetable and graduation journey. An all-in-one university focused web-based application for students, by students.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Run the following command to setup and run a local copy of the project.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Clone the project
git clone https://github.com/SMU-IS216G6T10/smumods-frontend.git-
Create a .env file from the sample
!! Remember to update the values in the env file with the right values!
cp ./.env.sample ./.env- Install dependencies
npm ci# launch development environment
npm run devThis project is deployed automatically via Netlify with hooks listening on push to the main branch and every pull request.
To mimic a production deployment, run:
- install serve, a static site, single page application server
npm install -g serve- Build the app
npm run build- Serve the app on a mimicked production environment
-s flag means to serve it in Single-Page Application mode which deals with the routing problem below
serve -s distIf your static frontend is deployed to a different domain from your backend API, you will need to properly configure CORS
David Lin - david.lin.2021@smu.edu.sg
Project Link: https://github.com/SMU-IS216G6T10/smumods-frontend
IS216 G6 Team 10