https://github.com/shyamsundernt/chat-sync-backend
Chat-sync-backend
https://github.com/shyamsundernt/chat-sync-backend
atlas dotenv javascript mongodb mongoose mysql nodejs
Last synced: 2 months ago
JSON representation
Chat-sync-backend
- Host: GitHub
- URL: https://github.com/shyamsundernt/chat-sync-backend
- Owner: ShyamSunderNT
- Created: 2024-07-08T06:59:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T15:33:11.000Z (almost 2 years ago)
- Last Synced: 2025-09-12T11:56:27.017Z (9 months ago)
- Topics: atlas, dotenv, javascript, mongodb, mongoose, mysql, nodejs
- Language: JavaScript
- Homepage: https://chat-sync-backend-gin7.onrender.com/
- Size: 36.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Chat-Sync Backend API Documentation
Welcome to the documentation for the Chat-Sync backend API. This API provides endpoints for user registration, authentication, and chat functionalities.
Base URL
The base URL for all endpoints:
bash
https://chat-sync-backend-gin7.onrender.com/api
Register User
Register User
Register a new user with first name, last name, email, and password.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/signup
Description: Endpoint for registering a new user.
Authentication
Activate Account
Activate user account using the activation token received via email.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/signin
Description: Endpoint for user authentication.
User Profile
Get User Profile
Retrieve user profile information.
URL: GET
https://chat-sync-backend-gin7.onrender.com/api/profile
Authorization: Bearer Token
Update User Profile
Update user profile information.
URL: PUT
https://chat-sync-backend-gin7.onrender.com/api/profile
Authorization: Bearer Token
Chat Operations
Send Message
Send a message to a specific user.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/chat
Authorization: Bearer Token
Create Group Chat
Create a group chat with specified users.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/chat/group
Authorization: Bearer Token
Rename Group Chat
Rename an existing group chat.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/chat/rename
Authorization: Bearer Token
Remove User from Group Chat
Remove a user from a group chat.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/chat/groupremove
Authorization: Bearer Token
Add User to Group Chat
Add a user to an existing group chat.
URL: POST
https://chat-sync-backend-gin7.onrender.com/api/chat/groupadd
Authorization: Bearer Token
API Documentation
For detailed API documentation, including request formats and response schemas, please refer to Postman Documentation.
In this README.md file:
Each endpoint is listed with its URL and a brief description.
Authorization requirements (Bearer Token ) are specified where necessary.
A section is provided for linking to more detailed API documentation hosted on Postman.
Make sure to replace with the actual authorization token format your API expects, and adjust the URLs and descriptions according to your specific implementation. This structure will help developers understand and effectively utilize your chat application backend API.