Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salamjillani/salamchat-chatapp
SalamChat-Real Time Chat App
https://github.com/salamjillani/salamchat-chatapp
expressjs mongodb nodejs reactjs socket-io tailwindcss
Last synced: 3 days ago
JSON representation
SalamChat-Real Time Chat App
- Host: GitHub
- URL: https://github.com/salamjillani/salamchat-chatapp
- Owner: salamjillani
- Created: 2024-12-11T00:10:26.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-03T15:48:34.000Z (about 1 month ago)
- Last Synced: 2025-01-25T00:19:30.953Z (21 days ago)
- Topics: expressjs, mongodb, nodejs, reactjs, socket-io, tailwindcss
- Language: JavaScript
- Homepage: https://salamchat.vercel.app
- Size: 4.87 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SalamChat
A real-time chat application built using the MERN stack (MongoDB, Express.js, React.js, and Node.js) with Socket.IO for real-time communication.
## Features:
- **Real-time chat:** Send and receive messages with other users instantly.
- **User authentication:** Sign up and sign in to the application.
- **Private messaging:** Chat with individual users privately.
## Setup
### Prerequisites
- Node.js
- npm
### Clone the repository:
```bash
git clone https://github.com/codesofsalam/salamchat-chatapp.git
```
### Install dependencies:
```bash
cd salamchat-chatapp
npm install
```
### Create a `.env` file in the root directory of the project and add the following environment variables:
```
MONGODB_URI=your_mongodb_uri
PORT=5001
JWT_SECRET=your_jwt_secret
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret
NODE_ENV=development
```
Replace the placeholders with your own values:
- **MONGODB_URI:** Your MongoDB connection URI.
- **PORT:** The port on which the server will run (default: 5001).
- **JWT_SECRET:** A secret string used for generating JSON Web Tokens (JWTs).
- **CLOUDINARY_CLOUD_NAME:** Your Cloudinary cloud name.
- **CLOUDINARY_API_KEY:** Your Cloudinary API key.
- **CLOUDINARY_API_SECRET:** Your Cloudinary API secret.
### Build the app:
```bash
npm run build
```
### Start the app:
```bash
npm start
```
## Usage
- Open the application in your web browser at [http://localhost:5001](http://localhost:5001) (or the port you specified in the `.env` file).
- Sign up or sign in to the application.
- Start chatting with other users!
## Repository Information
- **Repository:** [codesofsalam/salamchat-chatapp](https://github.com/codesofsalam/salamchat-chatapp)
## Language Composition
- **JavaScript:** 99.3%
- **Other:** 0.7%