liumcse / ntuvibe

NTUVibe is a student-run online platform committed to making information at Nanyang Technological University more open and accessible.

Build the largest and greatest student-run open source project in the history of NTU.

NTUVibe

NTUVibe is a student-run online platform committed to making information at Nanyang Technological University more open and accessible. Launched in August 2018, NTUVibe has helped thousands of students plan courses, create timetables and most importantly, make well-informed decisions.

Development

Start with cloning this repository

Front End

1. Go to www.
2. Install Node 8 or later. We use yarn as package manager.
3. Run yarn to install dependencies.
4. Run yarn start to start the development server.
5. Open http://localhost:8080 to view the front end.

Back End

1. Go to api/.
2. See the REAEME.md under folder api/.

Architecture

Front-end

React + Redux model, a single page application with multiple routes.

Back-end

Python Django (Python 3+), Redis, MySQL.

Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub