README

Date: April 24, 2011

This is a chat server I created using Node.js.

Functions
1) TCP server listening to port 828
2) Multiple clients can login.
3) Clients are assigned randon user names.
4) Clients can create their own user name
5) No Persistence, (No data is stored, all data is lost when the chat server shuts down)
6) No logging
7) Support for custom commands for Clients.
      Currently supports only 3 commands
        about
        list_users
        quit
8) No client interface, use Telnet
9) When client exits the chat server informs other clients about the departure.


Steps to Install and Use

For Admins
Step 1) Install node.js
Step 2) Download this from GitHub
Step 3) cd NodeChat
Step 4) node start_server.js

For Clients
Step 1) telnet <ipaddress of server> 8282

8282 is the port number where the server is listening to.

This server uses TCP  sockets.


Have read a lot about node.js, so decided to write something.
This project was born out of that curiosity.

Chat Server, uses the TCP sockets to allow telnet (or similar products) to communicate with each other.
Command based application, which does basic functionality such as
a) loging in users
b) keep track of all users
c) sending messages to users
d) allowing users to execute special commands.
e) handling conditions when clients stop using their server.

This is not a complete server. It has not taken into consideration security, hacks, malicious intent of use.
This was built purely for educational reasons.

Am I planning on [perfecting/completing/fixing bugs in] this project?
Nope. Simply because I dont have the time or need for it at this point of time.

Was fun going through the documentation of the nodejs and learning new stuff.

version of nodejs used: 0.4.6

Thanks,
Who shot the sheriff? - Bob Marley.