CUtopia

The source code for cutopia.app.

CUtopia is a course review and timetable planning website for CUHK students. It provides a platform for students to share their opinions and pick the course that best fits them.

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 welcomed to submit your issues and pull requests to dev branch after read the contributing guide .

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

You can come and join our telegram group 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 resume / github profile.

Guidelines

Semester Data Update

Open tools/data.ipynb and run all sections

Incorrect Data Correction

Please submit PR / issue in cutopia-data repo.