CS2102 Project AY20/21 Team 1 Repository

📝 Table of Contents

• Team
• About
• Getting Started
• Built Using
• Acknowledgments

👨‍💻 Team

• Matthew Nathanael Sugiri A0183805B
• Joshua Tam A0190309H
• Tan Guan Yew A0183464Y
• Sean Lim A0187123H
• Glen Wong A0188100N

🧐 About

THE WEBSITE IS LIVE AT AT THIS LINK!!! Please find the project report here, preliminary constraints here, ER diagram here, and demo video here here!

🏁 Getting Started

The instructions below will help to get you set up to develop the project on your local machine.

Prerequisites

You will need to have:

• NodeJS
• PostgreSQL
• npm installed on your system

Setting up and installing

1. Clone the repo
2. Run the command below inside both in the /client directory and the root directory.

npm install

3. Start up your psql shell and then copy all the code from the database.sql file in the root directory and paste it in the shell to run the code to create the tables and functions for our schema.

psql -U postgres

6. Create .env file in the root directory and fill it with the 4 variables listed below and assign the corresponding values to them

jwtSecret
PG_USER
PG_HOST
PG_PASSWORD
PG_PORT
PG_DATABASE

Running the project

Front end

Make sure you are in the /client directory and run the command below.

npm start // This will start the front end in development mode.

Open http://localhost:3000 to view it in the browser.

Back end

Make sure you are in the root directory and run the command below.

node index // Run nodemon dev server.

🎈 Usage

Add notes about how to use the system.

🚀 Deployment

Add additional notes about how to deploy this on a live system. -->

⛏️ Built Using

• PostgreSQL - Database
• Express - Server Framework
• ReactJS - Frontend
• NodeJS - Server Environment

🎉 Acknowledgements

• README inspiration from here