CUtopia

CUtopia is an open-source course review and timetable planning platform used by thousands of CUHK students.

Planner Demo

Packages

Install node.js and yarn.

Scripts

For Windows users, please run the following scripts in Git Bash.

Bootstrap (install all dependencies)

yarn bootstrap

Start frontend dev server

yarn fe dev

Start backend dev server

# watch and compile files
yarn be watch

# run the server in a separate terminal
yarn be dev

Contributing

We'd love to accept your contributions to this project, you are welcome to submit your issues and pull requests to dev branch after reading the contributing guide .

The master branch is connected with cutopia.app, any updates on the master branch will rebuild the production website. Like the master branch, the dev branch is linked with dev.cutopia.app.

You can follow us on Instagram and DM us to discuss suggestions and new features.

If you want to join the development team (with access to AWS, GA, Sentry, and the database), please email us with your GitHub profile/resume.

Guidelines

Semester Data Update

Open tools/data.ipynb and run all sections

Incorrect Data Report

Please submit PR / issue in the cutopia-data repo.