dimitrikor / chatbackend-nodejs Goto Github PK

Node.js 8.9.0 LTS

• git clone https://github.com/daserthkm/hackathon
• npm install
• npm run start
• open http://localhost:5000

The npm command fails on some Windows systems. When you get a error on start like:

Error: [email protected] start: DEBUG=hackathon:* node ./bin/www

use the "run.bat" file to start the server.

• To access the endpoints you need to set the header attribute "Content-Type" to "application/json".
• The responses are jsend formated.

• { status: 'success', data: (object|null) }

• { status: 'error', message: 'short error message' }

• { "user_id": 1234, "room_id": 1234, "message": "Hello World", attachment_url: "http://example.com/image.png" }

• { "name": "Test room" }

• { "name": "Daniel" }

• { "user_id": 1234 }

• chats.cleared - All messages from room removed
  • Payload: { room_id }
• chats.new_message - New message received
  • Payload: { user_id, room_id, message_id, create_date, millisecond }
• messages.liked - Message was liked by one user
  • Payload: { user_id, message_id, create_date }
• messages.like_revoked - Message like was revoked
  • Payload: { user_id, message_id, create_date }
• rooms.created - New room created
  • Payload: { id, name, create_date }
• rooms.changed - Room properties changed
  • Payload: { id, name, create_date }
• rooms.deleted - Room deleted
  • Payload: { id, name, create_date }
• rooms.user_joined - User joined a room
  • Payload: { user_id, room_id, create_date }
• rooms.user_left - User left a room
  • Payload: { user_id, room_id, create_date }