Chestjs is a platform made with nestjs and mongodb for online chat. You can use it with REST API and WebSocket.

• Chest.js
  • Possibilities
  • REST API
    • User
      • Create a User
      • Update a User
      • Get a User
      • Delete a User
    • Channel
      • Create a Channel
      • Update a Channel
      • Get a Channel
      • Delete a Channel
    • Group
      • Create a group
      • Update a group
      • Get a group
      • Delete a group
    • Private chat
      • Create a private chat
      • Get a private chat
      • Delete a private chat
    • Chat
      • Create a chat
      • Update a chat
      • Get a chat
      • Delete a chat
  • WebSocket
    • Sending message
    • Reciving message
  • License

Possibilities of this repo with REST API:

1. Create/Update/Get/Delete User
2. Create/Update/Get/Delete Channel
3. Create/Update/Get/Delete Group
4. Create/Update/Get/Delete Private chat
5. Create/Update/Get/Delete Chats

Possibilities of this repo with WebSocket:

1. Send and recive message in realtime

You can see examples of usage with postman example in here: https://postman.com/scorpio-team/workspace/chest-js

First clone repo: git clone https://github.com/scorpio-demon/Chest.js.git

Go to the installed folder: cd Chest.js

Install all deps: npm i

Run app: npm run start

Main URL: http://localhost:3000/api

You can use in this method to handle data between client and database. You must send data with JSON method to the api.

Path: /user Method: POST

Path: /user Method: PUT

Path: /user/[custom_id] Method: GET

Path: /user/[custom_id] Method: DELETE

Path: /channel Method: POST

Path: /channel Method: PUT

Path: /channel/[custom_id] Method: GET

Path: /channel/[custom_id] Method: DELETE

Path: /group Method: POST

Path: /group Method: PUT

Path: /group/[custom_id] Method: GET

Path: /group/[custom_id] Method: DELETE

Path: /private_chat Method: POST

Path: /private_chat/[custom_id] Method: GET

Path: /private_chat/[custom_id] Method: DELETE

Path: /chat Method: POST

Path: /chat Method: PUT

Path: /chat/[custom_id] Method: GET

Path: /chat/[custom_id] Method: DELETE

Socket URL: http://localhost:3000

Sending and reciving message is aviliable with socket. You have to send data in JSON like REST API in here too. Just connect to the server and use listeners in way you want :)

Listener: sendMessage

Listener: reciveAllMessages

Eplanation: Get all messages in first connection

Listener: stopGettingMessageNotification

Eplanation: Stop getting new message notification

Listener: getMessageNotification

Eplanation: Start to get new message notification

This project is licensed under the MIT License - see the LICENSE file for details.

The MIT License is a permissive open-source license that allows you to freely use, modify, distribute, and sublicense this software for both commercial and non-commercial purposes. You can find the full text of the MIT License in the LICENSE file included with this project.

Feel free to fork this project and use it in your own work, but please make sure to give proper attribution and include the original license text.