Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ananyakumarisingh/quickchat
QuickChat is a Full Stack Chatting App. Uses Socket.io for real time communication and stores user details in encrypted format in Mongo DB Database.
https://github.com/ananyakumarisingh/quickchat
bcrypt expressjs javascript node-js reactjs socket-io
Last synced: 3 months ago
JSON representation
QuickChat is a Full Stack Chatting App. Uses Socket.io for real time communication and stores user details in encrypted format in Mongo DB Database.
- Host: GitHub
- URL: https://github.com/ananyakumarisingh/quickchat
- Owner: Ananyakumarisingh
- Created: 2023-05-14T06:42:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-01T13:33:44.000Z (about 1 year ago)
- Last Synced: 2024-10-11T12:11:35.069Z (4 months ago)
- Topics: bcrypt, expressjs, javascript, node-js, reactjs, socket-io
- Language: JavaScript
- Homepage:
- Size: 4.04 MB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# __QuickChat__ 💬
- __Deployed Backend__ = https://
- __Deployed Webite__ = https://
---
## 🏷️ What is __QuickChat__ ?
__QuickChat__ is a Full Stack Chatting App. Uses Socket.io for real time communication and stores user details in encrypted format in MongoDB Database.
---
## 🏷️ __Tech Stack Used__ :-
__Frontend:__
- HTML5
- CSS3
- JavaScript
- React.js
__Backend:__
- Node.js
- Express.js
- Socket.io
__Database:__ Mongo DB
## 🏷️ __Special Features of QuickChat__ :-
- ### Authenticaton
---
## 🏷️ __API Routes__ :
| METHOD | ENDPOINT | BODY | DESCRIPTION | STATUS CODE |
| --- | --- | --- | --- | --- |
| POST | /api/register | __name__, __email__, __password__, pic(Optional) | This endpoint should allow to register. Hash the password and store in MongoDB. | 201 |
| POST | /api/login | __email__, __password__ | This endpoint should allow to login after comparing the user's credentails. | 201 |
| GET | /api/user | | This endpoint should allow to search other users. | 200 |
| GET | /api/chats/ | | This endpoint should allow to get the chats. | 200 |
| POST | /api/chats/ | __userId__ | This endpoint should allow to send messages. | 201 |
| POST | /api/chats/group | __users__, __name__ | This endpoint should allow to create a group. | 201 |
| PUT | /api/chats/rename | __chatId__, __chatName__ | This endpoint should allow to rename a groups. | 202 |
| PUT | /api/chats/groupadd | __chatId__, __chatName__ | This endpoint should allow to add people to the group. | 202 |
| PUT | /api/chats/groupremove | __chatId__, __chatName__ | This endpoint should allow to remove someone from the group. | 202 |
## Run Locally
Clone the project
```bash
git clone https://github.com/Ananyakumarisingh/mern-chat-app
```
Go to the project directory
```bash
cd QuickChat
```
Install dependencies
```bash
npm install
```
```bash
cd frontend/
npm install
```
Start the server
```bash
npm run start
```
Start the Client
```bash
//open now terminal
cd frontend
npm start
```
## Made By :
- [@Ananyakumarisingh](https://github.com/Ananyakumarisingh)
Thankyou for your Time 💝