README.md

WHAT IS KEYWORD?

KEYWORD is a web application which uses socket.io to allow the joining and hosting of rooms, where users can gather and play a mafia-like game.

RULES OF THE GAME

Every user is given a word correlating to the category chosen, they are a SCIENTIST. However, among one of the scientists is a CYBORG, they do NOT know the word. Everybody take turns saying something that relates to the word given. The goal of the scientist is to figure out who the cyborg is and the goal of the cyborg is to blend in with the crowd. After the timer runs out, the players will choose who the cyborg is, if the cyborg is chosen, they get one chance to win by guessing what the word given is, so be specific but not too specific as to not let the cyborg guess the word and be generic but not too generic as to not get chosen as the cyborg! Have fun!

DEPLOYED LINK HERE!!

https://warden-games.vercel.app/keyword

How to run frontend

First, go into the frontend directory

cd frontend

Run npm install to install packages needed for the frontend

npm install

Then run one of the following commands to run the frontend. (Suggest to use npm run dev)

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

How to run the backend

First, go into the backend directory:

cd backend

Run npm install to install packages needed for the backend

npm install

Then run commands to run the backend.

node server.js

CONTACT US

KJ (Backend Developer) - [email protected] Patrick Sun (Frontend Developer) - [email protected] Joshua Sy (Team Lead & Developer) - [email protected] David (Frontend Developer) - [email protected]