- Work in a fork of this repository
- Work in a branch on your fork
- Write all of your code in a directory named
lab-
+<your name>
e.g.lab-susan
- Open a pull request to this repository
- Submit on canvas a question and observation, how long you spent, and a link to your pull request
Configure the root of your repository with the following files and directories. Thoughfully name and organize any aditional configuration or module files.
- README.md - contains documentation
- .env - contains env variables (should be git ignored)
- .gitignore - contains a robust
.gitignore
file - .eslintrc.json - contains the course linter configuratoin
- .eslintignore - contains the course linter ignore configuration
- package.json - contains npm package config
- create a
lint
script for running eslint - create a
test
script for running tests - create a
start
script for running your server
- create a
- lib/ - contains module definitions
- __test__/ - contains unit tests
For this assignment you will be building a TCP chatroom. Clients should be able to connect using a telnet client nickname them selfs and talk to each other. Clients should also be able to run special commands to quit, list users, reset their nickname, and send direct messages. You may add as many featrues to the chat as you would like. Do not use any third party librarys in your chatroom modules.
- Create a TCP Server using the NodeJS
net
module - Create a Client constructor that models an individual connection.
- Each client instance should contain at least an
id
,nickname
, andsocket
.
- Each client instance should contain at least an
- Clients should be able to send messages to all other clients by sending it to the server
- Clients should be able to run special commands by sending messages that start with a command name
- The client should send
@quit
to disconnect - The client should send
@list
to list all connectued users - The client should send
@nickname <new-name>
to change their nickname - The client should send
@dm <to-username> <message>
to send a message directly to another user by nickname
- The client should send
- Connected clients should be maintained in an in memory collection called the
clientPool
- When a socket emits the
close
event, the socket should be removed from the client pool - When a socket emits the
error
event, the error should be logged on the server - When a socket emits the
data
event, the data should be logged on the server and the commands below should be implemented
- When a socket emits the
In your README.md describe the exported values of each module you have defined. Every function description should include it's airty (expected number of paramiters), the expected data for each paramiter (data-type and limitations), and it's behavior (for both valid and invalued use). Feel free to write any additional information in your README.md.
Also write documention for starting your server and connection using telnet. Write documentation for the chat room usage.
No testing required for this lab. Yay!
Use net.Socket to test your server. Your tests should include the ability to connect, send and recieve messages, and run special commands.