icebreaQ-server

This is the server implementation of icebreaQ. It is built with express, node-gyp, napi, socket.io.

Demo Site

Environment

• node v14.20.1
• mongodb-latest

Get Started

We assume this project is installed on ubuntu 16.04 or macOS.

Before Download

You should install

• node v14.20.1
• mongo db

WE RECOMMEND INSTALLING node VIA nvm

1. Install nvm
2. nvm install 14
3. nvm use 14

(Optional) MongoDB Configuration

If you want to use your own MONGO DB environment, then

Install & Run mongodb

Download and Configuration

1. download the git repository and install dependencies

git clone https://github.com/Team-ILA/icebreaQ-server.git
cd icebreaQ-server
npm install

2. set configuration for the server

cat .env.example > .env
sh ./configure_bindings.sh

You should fill all the environment variables correctly in .env as described.

Running the Program

# FOR DEV (tracks code changes)
npm run dev

# FOR PRODUCTION
npm run build
npm start

API Document

COMMON PREFIX: /api

METHOD	API	DESCRIPTION	NOTES
POST	/users/resgister	sign up users with email, password, username.
POST	/users/login	sign in users with registered email and password.
GET	/users	get user info if a user is logged in. (session)
POST	/quiz	create a quiz	requires login
GET	/quiz/:quizId	get information of a quiz	requires login
GET	/quiz/:quizId	get information of a quiz	requires login