Nott Course

An unofficial enhancement of the University of Nottingham course catalogue

View Current Build · Open Issues

About The Project

Better UX for the UoN course catalogue. The official catalogue contains abundant useful information regarding modules and academic plans, but is extremely frustrating to use. Built for potential or current students to better utilise publicly available data for their plan or module choices, Nott Course is featured with

• FULL data of current year's catalogue;
• Responsive UI design;
• Free navigation from plans to modules;
• Advanced filters for modules and plans;
• Easy drafting of module selections;
• Generating a list of assessments based on selected modules.

See the open issues for a full list of proposed features and known issues.

The current developers have graduated from UoN. If you would like to take over this project, please contact me via the email at the bottom of this page.

Built With

• React.js;
• Material UI;
• Hosted on Cloudflare Pages.

Sister Repos

This repo only contains the frontend of this web project. It is built in conjunction with the following:

• The C++ backend server and
• The new (as of October 2024) Python crawler.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/EricWay1024/nott-course.git

2. Install NPM packages

   npm install

Usage

Start a local server:

npm start

Production build:

npm run build

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Yuhang "Eric" Wei - [email protected]

Acknowledgments

• uFair-Tech/uCourse-crawler
• Course Extract
• othneildrew/Best-README-Template
• Favicon Generator - Text to Favicon - favicon.io