https://github.com/yasir761/chatty
Chatty is a real-time chat app with a clean design, easy conversation management, and simple features for staying connected.
https://github.com/yasir761/chatty
mern-stack monogodb react socket-io
Last synced: 10 months ago
JSON representation
Chatty is a real-time chat app with a clean design, easy conversation management, and simple features for staying connected.
- Host: GitHub
- URL: https://github.com/yasir761/chatty
- Owner: Yasir761
- Created: 2025-01-06T05:46:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-08T06:54:41.000Z (10 months ago)
- Last Synced: 2025-03-08T07:30:05.090Z (10 months ago)
- Topics: mern-stack, monogodb, react, socket-io
- Language: JavaScript
- Homepage:
- Size: 8.38 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Web-Based Chat Application
This is Web-Based Chat-Application developed using the MERN (MongoDB, Express.js, React.js, Node.js) stack. It allows users to register, log in, and chat with other users in real time.
## Features
- User authentication: Users can register and log in securely.
- Real-time messaging: Users can chat with each other in real-time.
- Responsive design: The app is responsive and works well on both desktop and mobile devices.
- Live notifications for new incoming messages.
- Online user facility indicating which users are currently online.
## Technologies Used
- MongoDB: NoSQL database for storing user data and chat messages.
- Express.js: Web application framework for Node.js used to build the backend server.
- React.js: JavaScript library for building user interfaces.
- Node.js: JavaScript runtime environment for running server-side code.
- Socket.io: Real-time engine for WebSockets to enable real-time communication between clients and server.
- Tailwind/CSS: Markup and styling for the front end.
---
## Installation
1. Clone the repository:
```bash
git clone https://github.com/Yasir761/Chatty
```
2. Navigate to the project directory:
```bash
cd Chat-Application
```
3. Install dependencies for both frontend and backend
> For frontend dependencies Go to the frontend folder `Package.json` file
and see all dependencies for installation
```bash
npm i
npm i all_dependencies_name
```
> For Backend Dependencies Go to the Chat-Application folder & refer directly available `package.json` file:
```bash
npm i
npm i all_dependencies_name
```
4. Set up environment variables:
- Create a `.env` file in the `Chat Application folder` directory.
- Define the following variables in the `.env` file:
```
PORT = 5000
MONGODB_URI =
JWT_SECRET =
```
5. Run the development server:
```bash
npm run start
```
6. Open your browser and navigate to `http://localhost:5000` to view the app functionality.
---
## Usage
1. Register for an account or log in if you already have one.
2. Once logged in, you'll be redirected to the chat interface.
3. Start messaging with other users who are online in real-time.
---
## Contributing
Contributions are welcome! Feel free to open issues or pull requests for any improvements or new features you'd like to see added.