1 Chat Documentation

Erin Nova edited this page 2021-07-24 16:48:52 +00:00

Table of Contents

• Chat Documentation
• API Documentation
• Chat Planning

Chat Documentation

API Documentation

POST /api/message/send Post a message with JSON body values of: name & body

Will return JSON with status and reason.

GET /api/message/messages.json Returns a json file of all the messages

Chat Planning

Clientside js will register & check login of users, if login is correct will ask for a random token. Backend will generate token, store it, and then send it to the client to set as a cookie. Whenever user sends a message, client will send message & token and backend will check if token matches.

Chat backend is going to switch from json to websockets as described in issue#3.

Frontend should also eventually display pronouns, display user roles, show commands differently from regular text, and possibly have emote support too.