Word Wizard - Client Socket.io

an EnSeven production

EnSeven is a student organization

CLIENT TEAM: Ashley Breunich, Mike Kermes, Brandon Haynes, Nicholas Welch

For a look at the entire project repo, please click here.

Purpose

The purpose of this project is to illustrate our cumulative knowledge of backend web development through the example of a game, consisting of a custom built API, a client server and a game made with socket.io.

Playing the Game

In order to play Word Wizard, users will need to fork the client repo and clone (git clone) it down to their machine. They can use this link to access the repository.

1. Once the repository is on the computer, users will then need to install all dependencies (by typing npm install into terminal)

2. In order to start a game, a player will need to type nodemon OR node client.js into terminal. Users will then be connected to the game server and will be prompted to either CREATE an account or LOGIN to an existing account.

Functionality between Client and Game-Engine

The client.js file is a Socket.IO server that connects to the game server's Heroku link. Upon starting up the client in the terminal (nodemon OR node client.js), a user will be connected to the game server and prompted to either CREATE a new account or LOGIN to an existing account. These prompts are initiated by both Readline and the npm package Prompt, which, based on a schema, prompt the user for their email (must be unique), username (must be unique), and password. See documentation links in Citations section below.

Once a token is sent back from the API to the game server, the game server notifies the client server. Upon receipt of notification the user is signed in and able to request to join the game.

Functionality between Game-Engine and API

Game-Engine is a Socket.IO server that connects to both Client server and the API. Once a user has selected to either create or login as an existing user, Game-Engine sends the user data; username, password, and email to the API. The API sends back a token using JWOT. The token is an authenticator for data transfers between Game-Engine and API.

API functionality

The API server provides the interface to the persistence layer, which is implemented using MongoDb. When users sign up, or return to play again, the API is accessed. The game engine uses API services to persist and retrieve information about wins and losses. For further documentation on the API please see additional documentation

Code Samples

Client Server example code {user connected}

socket.on('start', (payload) => {
  console.log('payload', payload);
  socket.emit('connected', `Player ${socket.id} ready`);
  console.log(`Player ${socket.id} has joined the game`);
});

Socket.io example code {user disconnected}

  socket.on('disconnect', () => {
    socket.removeAllListeners();
    console.log(`Player ID ${socket.id} has left the game`);
  });

API example code {user signs in}

authRouter.post('/signin', auth(), (req, res, next) => {
res.cookie('auth', req.token);
res.send(req.token);
});

Citations

Express Documentation

Chalk Documentation

Prompt Documentation

Readline Documentation

Socket.IO Documentation

Additional mentions

Our Wonderful TA team

Cara Ottomar - LinkedIn

Ed Abrahamsen - LinkedIn

Other

Word Wizard was inspired by a command line hangman game