README.md

CZ3003 SSAD Educational Game (Frontend)

An educational game built with React.

This project involves creating a social game to socialize and gamify the teaching and learning of the educational modules’ contents. Through this game, students will be able to learn and compete with each other in the form of trivia games while enjoying themselves and teachers will be able to assess the students’ progress via data analysis.

Installation Guide

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisite

The following command-line interfaces (CLI) are needed:

1. npm (included with Node.js)

Installation Instructions

1. Install Node.js

Node.js comes with the npm (node package manager) cli which we will be using for the rest of the setup.

Download and install Node.js here.

2. Clone from this repository

Navigate to your preferred root directory.

Next, clone frontend from GitHub by entering the following Git command:

git clone https://github.com/10Complement/cz3003-frontend.git

3. Install Dependencies

We will now install the required dependencies with this command:

npm install

4. Run development server

This step requires an internet connection to be interact with the backend APIs.

Run with development server:

npm start

The homepage should now be visible on your default browser.

Built With

• React - A JavaScript library for building user interfaces

Frontend Authors

• Kyle Huang Junyuan - @HJunyuan
• Ngoh Guang Wei - @GuangWeiNgoh
• Nelson Ko Mingwei - @NelsonKo93
• Kremer Iris Pascale - @IrisBICS
• Khin Yamin Thu - @yummilicious
• Sri Ashwari D/O Rajkumar Pillai - @Ashwari97
• Muhammad Muhaimin Bin Tahir - @NightWolf5

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• Asst Prof Lin Shang-Wei - Lab supervisor