UoM Assistant

An all-in-one productivity tool to help coordinate uni work. Designed for you.

Languages: English | Chinese (Simplified)

Development

This project is still under development. Please don't use it as a final product.

Progress

Frontend:

• Clock widget
• TO-DO widget
• Coursework widget
• Course manage widget
• Calendar widget
• Quick links widget
• Online session links widget
• Quick notes widget
• Attendance widget
• Overview widget
• Inbox widget
• Grade summary widget
• Plug-in widget
• Search
• Set up guide
• Settings page
• About page
• Logo

Backend:

• Database
• Ability check API
• Attendance API
• Calendar API
• Inbox API
• Send mail API
• Grade summary API
• Sync settings API
• Clear data API
• CLI tools

Introduction

UoM Assistant is a web app that offers many helpful tools for students in Department of Computer Science, University of Manchester. All the information you need for your study life is now in one place and reachable with a glance.

This project was originally a personal project, born during the pandemic with all the courses were moved to be online, and I needed a panel that could gather and display all the information I needed for study. As the project gradually improved, I started to develop it as a formal project and named it as UoM Assistant.

Features

• Get known of your course schedule with a glance
• Open online sessions by one click
• Easily check your attendance and grades
• Forget how to calculate the time difference, let the widget tell you
• Precise time zone and DST support
• Check your inbox in the same page and keep away from phishing and spam emails
• A bunch of useful extras to help you organise your study life
• Control all your private data and safely sync them across devices
• Third-party plug-in support
• Elegant and easy-to-use UI with dark mode support
• i18n ready: English (UK), Chinese (Simplified), Spanish and Japanese are currently supported. Locale status & maintainers
• ...

Deploy guide

Frontend

Download latest frontend.zip from Releases, and decompress the files to the root directory of your site. Note that UoM Assistant must be deployed to the root directory of a site.

To make router working properly, you need to update the config of your server. If you are using Nginx, you can add these lines to your site config:

location / {
  try_files $uri $uri/ /index.html;
}

or you may using Apache (.htaccess is already provided):

<IfModule mod_rewrite.c>
  RewriteEngine On
  RewriteBase /
  RewriteRule ^index\.html$ - [L]
  RewriteCond %{REQUEST_FILENAME} !-f
  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteRule . /index.html [L]
</IfModule>

Deploy frontend with JAMstack platforms

    

or Deploy with Cloudflare Pages

Backend

Download latest backend.zip from Releases, and decompress the files to the right place of your site. Edit config.php, and your backend is now on. Note that to enable mail related features you need to install following PHP extentions: fileinfo, imap and mbstring.

Deploy backend with serverless platforms

  

More about backend usage

Deploy with Docker

If you are using docker, docker-compose.yml has already offered you a good start. Check out the file and modify it as you want.

Build and deploy from source

Make sure you have npm and composer installed.

Frontend

$ git submodule update --init --recursive
$ npm install
$ npm run build

...and deploy the dist folder.

Backend

$ cd backend

...edit config.php, then

$ composer install --no-dev --optimize-autoloader
$ cd ../

...and deploy the backend folder.