Skip to content

Latest commit

 

History

History
103 lines (78 loc) · 4.69 KB

README.md

File metadata and controls

103 lines (78 loc) · 4.69 KB
Raw

MyUIC Neo

An "unofficial", third-party student portal website for UICians.

Demo | Twitter Thread | Feedback Form

Vercel mirror Twitter Follow GitHub Follow

Description

MyUIC Neo is a student-made implementation of MyUIC: the student portal web application of the University of the Immaculate Conception. The focus of MyUIC Neo is to provide better user experience and better user interface for UIC students by using modern web standards and design techniques.

It is both a single-page application (SPA) and a progressive web application (PWA) for smooth native-app like experience on any device whether be on the phone, on the tablet, or on the desktop.

Why?

Information through online platforms became the norm after the start of the online class mandate. Thus, any data related to financial payments, student grades were heavily relied on the MyUIC student portal. As a student myself of the school along with others, the experience was not good and the information it provides does not utilize it very well to the point that to get the right information, you must go to a series of links which should be exposed directly in the first place.

With this, it hopefully solves the dissatisfaction and other problems experienced by the students.

Native Application

MyUIC Neo can also be used as a mobile application both for iOS and Android with the help of CapacitorJS. Unlike the web-only version, the mobile app provides features such as offline notifications, fingerprint authentication, persistent session, and etc.

To get started, please refer to the "Run as Android app" and "Run as iOS App" sections.

Prerequisites

Web

  • Node 16 or later
  • NPM

Android

Android compilation is optional but is required if you want to compile it as an Android app.

  • Android SDK (30 and above)

iOS

  • Xcode 13 or later
  • iDevice or Simulator
  • Cocoapod
  • CapacitorJS $ sudo gem install cocoapods
    • FOR APPLE SILICON MACS ONLY: $ sudo arch -x86_64 gem install ffi

Installation

To run MyUIC Neo on your local computer, simply execute the following commands:

npm

git clone https://github.com/nedpals/myuic-neo.git
cd myuic-neo
npm install
npm run dev

This will start the Vite webserver at http://localhost:3000. You may login by typing 123456789012 as the student ID and myuicneo as the password.

Run as Android App

See the Android prequisites for requirements on how to build the Android app.

To run the app, simply run:

npm run start-android

This will build the web app, inject it's contents, and install the app to your simulator or your device.

Run as iOS App

See the iOS prequisites for requirements on how to build the iOS app.

To run the app, simply run:

npm run start-ios

This will build the web app, inject it's contents, and install the app to your simulator or your device.

Additional Resources

Wanna contribute? Here are the following resources you can use when working on the MyUIC Neo codebase:

Contributing

  1. Fork it (https://github.com/nedpals/myuic-neo/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

AGPL v3

Contributors