https://github.com/dulanjalisenarathna/mern-chat-app
Mern chat web application
https://github.com/dulanjalisenarathna/mern-chat-app
chat-application mern mern-chat mern-chatapp mern-project mern-stack mern-stack-development mernstack react-chat-app socket-io
Last synced: about 2 months ago
JSON representation
Mern chat web application
- Host: GitHub
- URL: https://github.com/dulanjalisenarathna/mern-chat-app
- Owner: DulanjaliSenarathna
- Created: 2024-07-07T02:09:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-21T14:20:24.000Z (9 months ago)
- Last Synced: 2025-01-30T13:41:47.316Z (4 months ago)
- Topics: chat-application, mern, mern-chat, mern-chatapp, mern-project, mern-stack, mern-stack-development, mernstack, react-chat-app, socket-io
- Language: JavaScript
- Homepage: https://mern-chat-app-9apk.onrender.com/
- Size: 1.55 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chat App (MERN Stack)
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Screenshots](#screenshots)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [Contact](#contact)
## Introduction
This is a full-stack chat application built using the MERN stack (MongoDB, Express, React, Node.js). The application allows users to create accounts, log in, and engage in real-time messaging with other users.
## Features
- User authentication and authorization
- Real-time messaging using Socket.io
- Private and group chats
- Message notifications
## Technologies Used
- **Frontend:** React.js, React Context API, React Router
- **Backend:** Node.js, Express.js
- **Real-time Communication:** Socket.io
- **Database:** MongoDB
- **Authentication:** JWT (JSON Web Tokens)
- **Styling:** CSS
## Installation
### Prerequisites
- Node.js
- MongoDB
### Clone the Repository
```sh
git clone https://github.com/DulanjaliSenarathna/mern-chat-app.git
cd mern-chat-app
```
## Backend Setup
Navigate to the backend directory:
```sh
cd backend
```
Install dependencies:
```sh
npm install
```
Create a .env file in the backend directory and add the following:
```sh
PORT=5000
MONGO_URI='mongodb+srv://dulanjalisenarathna93:[email protected]/?retryWrites=true&w=majority'
JWT_SECRET=dulanjali
NODE_ENV=production
```
Start the backend server:
```sh
npm start run
```
## Frontend Setup
Navigate to the frontend directory:
```sh
cd frontend
```
Install dependencies:
```sh
npm install
```
Start the frontend server:
```sh
npm start run
```
## Usage
Access the customer-facing app at http://localhost:3000.
Register as a new user or log in with existing credentials.
Create or join a chat group.
Pay using dummy visa card
Start chatting with other users in real-time.
## Screenshots
## API Documentation
The API endpoints for the backend can be documented using tools like Postman or Swagger. Include endpoints for user authentication, menu items, orders, and more.
## Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes. Make sure to follow the code style and include relevant tests.
## Contact
For any questions or suggestions, feel free to contact me.
Happy coding!
Feel free to customize this template according to your specific project details and requirements.