renejfc / support-chat Goto Github PK

• Should work smoothly in most major browsers
• Should be responsive across devices

• It's ready.
  or
• Document next steps in order to be.

• Setup styles workflows.
• Global styles.
• Style tokens
• Mockup

• Unit.
• Component.
• E2E.

Needs #4

• Unit testing.
  • Partially.
• Component testing.
  • Partially.
• E2E testing.
  • Partially.

Login page with text fields for user and password and a button to submit.

• Should not send an HTTP request if either of the fields are empty.
• Login returns a session token that needs to be stored and used for the rest of endpoints
• If the session token is already stored, the project should redirect to chat.
• Must have a distinct URL from the chat page.

API Definition

POST /login
  Request:
    { “user”: “USERNAME”, “password”: “PASSWORD” }    // Valid credentials are admin / admin
    Header: Content-Type: application/json

  Response:
    200 OK: { “session_id”: “TOKEN” }
    401 UNAUTHORIZED: no body

• Project setup instructions
• Decision making process
• Structured docs
• Extra comments

Chat page to interact with a bot.

Page with an input field for the user to send messages and the history of all the messages sent
and received so far.

• Distinct URL from the login page.
• Logout button.
• Must not send HTTP requests if the message field is empty.
• Must redirect to the login page if the session token does not exist or one of the queries
  returns a 401 Unauthorized.
• Upon entering, the page should show the welcome message as a message from the bot.
• Bot messages appearing one by one and with animations and/or a typing animation (optional)

API Definition

GET /getWelcomeMessage
  Request:
    Header: Content-Type: application/json
    Header: Authorization: Bearer SESSION_ID

  Response:
    200 OK: { “response”: [ BOT_MESSAGES ] }
    401 UNAUTHORIZED: no body

POST /sendMessage
  Request:
    Header: Content-Type: application/json
    Header: Authorization: Bearer SESSION_ID
    {“text”: “user message”}

  Response:
    200 OK: { response: [ BOT_MESSAGES ] }
    401 UNAUTHORIZED: no body

Where BOT_MESSAGES are a JSON object which can be one of the following:
  {“type”: “text”, “text”: “bot message”}
  {“type”: “image”, “url”: “image url”}