SMU Portal - Frontend

Table of content

• Overview
• Getting Started
• Features
• System requirements
• Prerequisites
• Dependencies
• Bug reports
• License
• Contact

Overview

SMU Portal is a free and open source portal for universities. It is a junior project developed for the ISS396 course taught at MedTech.
This repository is dedicated to the frontend of SMU Portal, you can find the backend here.

Getting Started

Please refer to our Installation Guide on GitBook.

Features

• Authentication with support for email and app based 2FA.
• Box reservation for all SMU departments.
• Expandable codebase with a built-in support for modules (called Apps).
• Email delivery system to notify user about changes related to their account (password reset, account confirmation, etc.).

System requirements

• This project was mainly developed on Windows 10, but since no OS dependent APIs were used, it should work on all operating systems supported by Node.js. If you encouter any compatibility issues refer to the bug reports section.

Prerequisites

• Node.js 12+ [Required to install Angular CLI]

Dependencies

All the dependencies are listed inside package.json. Here is a list of all the relevant frameworks and libraries used:

• angular
• bootstrap
• rxjs
• zone.js

Bug reports

To file one or multiple bug reports, please use the issue tracker related to the approriate repository.
N.B. Failure to report the bug in the relevant repository (only frontend bugs should be reported here) or to comply with the template instructions for creating an issue will result in the closure of said issue.

License

SMU Portal is licensed under AGPLv3 "or later" by default. Learn more about the permissions and limitations of this license here.

Contact

Please refrain from contacting the contributors of this project individually. Forward all your requests and feedback through these means:

• Email: [email protected]
• GitHub issue tracker: issue tracker (report bugs here)