Skip to content

jvanderen1/cli_chat

Repository files navigation

CLI Chat

Build Status Coverage Status

Introduction

This project is the culmination of work done by Joy Tan, Grant Savage, Joshua Van Deren, and Yen-Hung Lai for the Spring 2018 classes of SE420 Software Quality Assurance and SE310 Software Analysis and Design at Embry-Riddle Aeronautical University. This project is an interactive command line chat. It uses the web socket protocol to send and receive messages from multiple users. Our client application and server implementation will allow clients to send private messages to each other and join rooms to group chat with other users. Our system will also allow users to block other users. This project is currently in development and bugs will be present.

Quick Start Installation

To install the required dependencies for both client and server run the install.sh shell script by running ./install.sh. You may need to change permissions on the file to run it. To do this run chmod 755 install.sh.

Running the System

In order to run the system and interact with it, a total of 3 terminal sessions (tabs) are needed. 1 to run the server and 1 to 2 run the clients. Instructions on how to run on both the client and server are included in the README files under both the client and server directories under the src directory.

Running Tests

To run the tests, cd into the root directory and run npm test.