UOW Booking system

This is the system my group developed as group project assestment for CSIT214 at University of Wollongong. The system is meant to be an event booking system that can handle booking and manage events (paid or free) in a typical university.

Group member

• Andre Knell
• Xinya Lei
• Julia Aoqi Zhang
• Thien Bui

System requirement

The system require using Node.js 8.1.1 and Yarn 1.5.1 to run. Compatible Node.js can be found here. Lastest Yarn can be found here. The system also require a PostgreSQL database. The lastest version of PostgreSQL can be found here.

Getting started

After installing Node.js and Yarn, make sure the environment have following variables:

• DEV_DATABASE_URL: URL of the database for development/test environment (optional for production environment)
• DATABASE_URL: URL of the database for production environment (optional for development or test environment)
• IMGUR: Imgur client token to access upload feature of imgur.com
• PUBLIC_KEY: Stripe public key
• PRIVATE_KEY: Stripe private key

To ensure enviroment variables setup, it's recommended to use a .env file. To setup .env file, use command yarn setup:env

After having all the environment variables, the next step is to install all dependences and migrate the database. First, run command yarn install to install all of the system dependences. Then use command yarn setup:migrate to migrate the database. If there's any problem, or database need to be reset, command yarn setup:demigrate can be run to demigrate the database.

When all libraries are installed and the database is migrated, the website can be start with command yarn start

Credit

The system is ran using:

• Node.js for environment.
• Express.js for backend.
• EJS for frontend view engine.
• Yarn for backend package management.
• Bower for frontend package management.
• PosgreSQL for database.
• Sequelize for object relational mapping.
• Passport for user authentication.
• Stripe for payment processing.
• Imgur for image hosting.
• Heroku for demo website and database hosting.
• ElephantSQL for development database hosting.

Full list of libraries can be found in:

• package.json for backend library
• bower.json for frontend library

Some files in the project is automatically generated using express-generator and sequelize-cli or modified version of following tutorials: Using Passport With Sequelize and MySQL and Getting Started with Node, Express and Postgres Using Sequelize