Skip to content

ramenguy21/sequence-game

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

About The Project

Built With

  • Svelte
  • Express
  • Socket.io

(back to top)

Getting Started

The application is composed of two components. A client and server, you'll have to set both of them up for the application to function.

Prerequisites

In both ./web and ./server run

  • npm
    npm install --save

Installation

  1. Clone the repo
    git clone https://github.com/ramenguy21/sequence-game.git
  2. Install NPM packages
    npm install
  3. Enter relevant .env details, For server, the .env config is:
    PORT = 3000;
    For client,
    VITE_SERVER_ADDRESS="http://localhost:3000/"

(back to top)

Usage

To play the game, go to (http://localhost:5173/). Enter a username. It will print a string to the console. Copy the string, go to another tab with the same address, click on "Join a room" button, and enter another username and the previously copied string into the room name.

(back to top)

Roadmap

  • Dynamic lobby support.
  • Functioning game end check.
  • Support for reconnection.

(back to top)

Contact

Muhammad Hamza Asad - [email protected]

(back to top)