This chat app uses a RESTful Nodejs backend to create chat rooms where clients can communicate.
Authors:
- Adrian Tokle Storset, s341859
- Erik Storås Sommer, s341870
- Mats Sommervold, s341829
NOTE! If you are looking for delivery instructions, see README.pdf instead!
In docker:
- You can map the docker port (5000) to any port on your local machine.
- Static client is bundeled at the
/route - Runs in production mode
- Has push notifications over websockets enabled
You need docker installed to run the server in a docker container.
docker build -t rest-chat-app .
docker run -p 5000:5000 rest-chat-app // -p maps a docker port to a local port on your machine
To stop the docker container you could use:
docker stop $(dokcer ps -a -q)
Server:
Development mode:
- Server runs on port
5000(or port assigned by environment variablePORT) - Prints debug messages to the console
- Restarts the server whenever a project file is saved
- Uses an in-memory store
- provide
NOTIFY=falseif you don't want push notifications enabled
To run the server in development mode:
cd server
npm i
npm run dev
Production mode:
- Server runs on port
5000(or port assigned by environment variablePORT) - Does not print debug messages
- Uses an in-memory store
- provide
NOTIFY=falseif you don't want push notifications enabled
To run server in production mode:
cd server
npm i
npm run start
Client:
Development mode:
- Connects to host
localhost - Connects to port
5000 - Client server runs at port
5500 - Prints debug messages to the console
- Restarts the client whenever a client file is saved
- Will use push notifications if server has it enabled
To run the client in development mode:
cd app
npm i
npm run dev
Now, open your browser at localhost:5500 to interact with the client.
Production mode:
- The client runs packaged with the server in production mode. Just go to the
/route to get the client. - To run a second client at the same time, logged in as a different user, you have to run it in another browser or on another device as the client uses the
localStorageapi to keep logged when the browser is refreshed.
Bots:
Bots in the terminal:
- Connects to host
localhost(or port assigned by environment variableSERVER_HOST) - Connects to port
5000(or port assigned by environment variableSERVER_PORT) - Picks random username from a pool of names
- Will join the
botroom or create one if it doesn't exist yet. - Posts/responds to messages
- Will use push notifications if server has it enabled
To run a bot from the terminal:
cd client
HOST=localhost PORT=5000 node bot.js
Bots from UI:
- Picks random username from a pool of names
- Will join the room you create them in
- Posts/responds to messages in that room
- Will use push notifications if server has it enabled
To create bot in UI:
- Go to the client in your browser.
- Log in, create a room and select it from the rooms list.
- Then add a bot to the room by the panel on the right hand side.
NB: Make sure you are using the LTS version of node: v14.16.0.
Here you will find a list of every endpoint the chat api exposes and how to use each one
Creates a new user and returns a userID
Header:
Content-Type : application/json
Body:
{
"username" : "%username%",
"password" : "%password%"
}Response body:
{
"message" : "User created"
}Returns a list of all users
Header:
Token : "%Auth Token%"
Response body:
{
"users" : [
{
"id" : "%userID%",
"username" : "%username%"
}
]
}Returns a user
Header:
Token : "%Auth Token%"
Response body:
{
"user" : {
"username" : "%username%",
"id" : "%userID%",
"ownedRooms" : [ "%roomID%" ],
"rooms" : [ "%roomID%" ]
}
}Deletes a user specified by the userID
Header:
Token : "%Auth Token%"
Response body:
{
"message" : "User deleted"
}Authenticates user, establishes connection and returns a new tokenID
Header:
Content-Type : application/json
Body:
{
"username" : "%username%",
"password" : "%password%"
}Response body:
{
"token" : "%tokenID",
"message" : "Logged in"
}Returns token
Header:
Token : "%Auth Token%"
Response body:
{
"token" : {
"id": "%tokenID%",
"username": "%username%",
"expires": "%expiration date%"
}
}Extends token
Header:
Token : "%Auth Token%"
Response body:
{
"message" : "Session extended"
}Deletes and invalidates token
Header:
Token : "%Auth Token%"
Response body:
{
"message" : "Logged out"
}Creates a chat room
Header:
Token: %tokenID%
Body:
{
"name" : "%room name%"
}Response body:
{
"message" : "Room created"
}Gets all chat rooms
Header:
Token : "%Auth Token%"
Response body:
{
"rooms" : [
{
"id" : "%roomID%",
"name" : "%room name%",
"joined": true
}
]
}Get room
Header:
Token : "%Auth Token%"
Response Body:
{
"room": {
"id": "%roomID%",
"name": "%room name%",
"admin": "%userID%",
"users": [
"%userID%"
],
"messages": [
{
"sender": "%user name%",
"message": "%message%"
}
]
}
}Delete room
Header:
Token : %tokenID%
Response body:
{
"message" : "Room deleted"
}Add user to room
Header:
Token : %tokenID%
Body:
{
"user" : "%userID%",
}Response body:
{
"message" : "Added user to room"
}Get all users in room
Header:
Token : "%Auth Token%"
Response body:
{
"users" : [
{
"id" : "%userID%",
"username" : "%username%"
}
]
}Get all messages in room
Header:
Token : %tokenID%
Response body:
{
"messages" : [
{
"id" : "%messageID%",
"message" : "%message%",
"author" : "%userID%",
"time" : "%time sent%"
}
]
}Get all messages by user in room
Header:
Token : %tokenID%
Response body:
{
"messages" : [
{
"id" : "%messageID%",
"message" : "%message%",
"author" : "%userID%",
"time" : "%time sent%"
}
]
}Add message to room
Header:
Token : %tokenID%
Body:
{
"message" : "%message%"
}Response body:
{
"message" : "Message sent"
}Check if server has push notifications enabled
Response body:
{
"push" : "enabled/disabled"
}