https://github.com/getssh/chatapp
https://github.com/getssh/chatapp
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/getssh/chatapp
- Owner: getssh
- Created: 2024-10-31T09:51:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-18T10:55:07.000Z (about 1 year ago)
- Last Synced: 2025-01-18T11:36:08.534Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://et-chat.vercel.app
- Size: 1.28 MB
- Stars: 0
- 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
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Chat App MERN Stack** is a real-time chat application that allows users to send messages, view online statuses of other users, and authenticate using a secure signup and login system. Built with the MERN stack, the app uses Socket.IO for real-time communication, Tailwind CSS with DaisyUI for styling, and Zustand with Context API for state management.
Client
- React.js
-
Tailwind CSS with DaisyUI -
Zustand with Context API
Server
Database
- **Real-time messaging** using Socket.IO
- **User authentication** for secure login and signup
- **Online status visibility** to see active users
- [Live Demo Link](https://et-chat.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Node.js installed
- MongoDB set up locally or remotely
- A code editor like VS Code
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/getssh/chatApp.git
cd chatApp
```
### Install
Install the dependencies with:
```sh
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
### Run tests
To run tests, use:
```sh
npm test
```
### Deployment
You can deploy this project using platforms like Render, Vercel, or Heroku.
👤 **Getayawkal Tamrat**
- GitHub: [@getssh](https://github.com/getssh/)
- LinkedIn: [Getayawkal Tamrat](https://www.linkedin.com/in/getayawkal-tamrat/)
- [ ] Group chat functionality
- [ ] Message reactions
- [ ] Typing indicators
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, please give it a star on [GitHub](https://github.com/getssh/chatApp)!
I would like to thank the open-source community for the libraries and tools used in this project.
This project is [MIT](./LICENSE) licensed.