https://github.com/codewithkyle/simple-web-chat
A simple web chat prototype developed to test Socket.io
https://github.com/codewithkyle/simple-web-chat
Last synced: about 2 months ago
JSON representation
A simple web chat prototype developed to test Socket.io
- Host: GitHub
- URL: https://github.com/codewithkyle/simple-web-chat
- Owner: codewithkyle
- License: mit
- Created: 2017-01-20T18:05:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-26T22:43:16.000Z (over 9 years ago)
- Last Synced: 2026-01-01T21:51:54.071Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.69 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Table of Contents
1. [Introduction](#introduction)
1. [Install](#install)
1. [Usage](#usage)
1. [Team](#team)
1. [Code Style](#code-style)
1. [Contribute](#contribute)
1. [License](#license)
## Introduction
This is a simple web chat software developed as a homework assignment for a multiplayer games course at [Ferris State University](http://ferris.edu/dagd/). It is a prototype for another project, it's goal is to provide a basic introduction to creating rooms within [Socket.io](http://www.socket.io) along with running basic chat commands.
## Install
This project uses [Node.js](https://nodejs.org/en/) along with [Socket.io](http://www.socket.io) and [Express](http://www.expressjs.com). 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 - joins a specific room
/leave - sends user back to the default room
/color - changes the users color to a specific hex code
/clear - clears all previous messages
```
## Team
#### Creator
Kyle Andrews |
|-----|
| [Email](andrewskyle28@gmail.com) |
| @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](https://github.com/AndrewK9/Simple-Web-Chat/issues) or clone this repo and start working.
## License
[MIT](https://github.com/AndrewK9/Simple-Web-Chat/blob/master/LICENSE) (c) Kyle Andrews