Authors: Harry Simmonds Justin Domingue Keith Strickling

COMP307

How to use

Online

Navigate to aristochat.azurewebsites.net for an online demo of the chat app. It is connected to a Redis cache hosted on Azure.

Locally

cd comp307
$ npm install
$ node app.js

And point your browser to http://localhost:3000. Optionally, specify a port by supplying the PORT env variable.

Features

• Multiple users can join a chat room by each entering a unique username on website load.
• Users can type chat messages to the chat room.
• A notification is sent to all users when a user joins or leaves the chatroom.
• 'is typing' message
• Multiple rooms
• Private messages
• Unique usernames
• People joining see past messages (chat history)
• Chat bot
• Encryption
• Map
• Link formatting
• Notifications when users receive messages in tabs they are not currently on. Additionally, the title of the webpage changes when the user gets a new message but has not yet viewed it.

Using the app

• Start a private message by clicking on the username of a user you would like to chat with
• Join/create a room by typing ":join roomName" into the text box
• Leave a room you've created by typeing :leave roomName" into the text box
• The following chatbot features apply to the public room:
  • Ask the chatbot for pictures by typing ":picture" followed by what you would like a picture of
  • Ask the chatbot who's online by typing ":online"
• Try coping and pasting a link into the text box sending it. You should be able to click on the link! Make sure to right click and open it in another tab though

**************************** REDIS ************************

How to use REDIS:

Documentation: https://www.npmjs.com/package/redis

$ npm install redis

We then need to set the file to where the data will be saved

FROM comp307 base directory:

$cd node_modules/redis-stable/src $./redis-cli --will run redis client

Within Redis Client then type:

CONFIG SET dir ../../../ CONFIG SET dbfilename redisDatbase.rdb

---

To start redis server

FROM comp307 base directory:

$cd node_modules/redis-stable/src $./redis-server

NOTE: this will start on the default port described in redis.conf To change the conf, go to (from comp307 root)

$vim node_modules/redis-stable/redis.conf

• Then change port to desired port for redis server. Vim command : ?port *

---