Skip to content
A simple web chat prototype developed to test Socket.io
JavaScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
node_modules
.travis.yml
LICENSE
README.md
package.json
server.js

README.md

Table of Contents

  1. Introduction
  2. Install
  3. Usage
  4. Team
  5. Code Style
  6. Contribute
  7. License

Introduction

This is a simple web chat software developed as a homework assignment for a multiplayer games course at Ferris State University. It is a prototype for another project, it's goal is to provide a basic introduction to creating rooms within Socket.io along with running basic chat commands.

Install

This project uses Node.js along with Socket.io and Express. Go check them out if you don't already have them installed locally. Alternatively this repo already has the node modules installed and will keep them up to date.

Usage

Server

To launch the server just run the server.js file with nodejs.

Client

To access the web page open a browser and go to localhost:1234. Then choose a username, the server will make sure said name is available.

Listed below are the currently accpeted commands:

/help - pulls up all possible commands
/room - tells the user what room they're in
/list - list all available rooms
/join <room> - joins a specific room
/leave - sends user back to the default room
/color <hex> - changes the users color to a specific hex code
/clear - clears all previous messages

Team

Creator

Kyle Andrews
Email
@andrewk9

Code Style

Tabs not spaces, for this project we will be using four spaced tabs when indenting. All selection and iteration statements will have a beginning and ending curly brace, including single-line statements.

if(x == y) { return true; }

Contribute

Feel free to open an issue or clone this repo and start working.

License

MIT (c) Kyle Andrews

You can’t perform that action at this time.