ChatEZ is a modern, full-stack real-time chat application designed to deliver seamless and efficient communication. With a responsive, visually appealing user interface, secure user authentication, and instant real-time message updates, ChatEZ ensures a smooth and engaging user experience for both personal and professional use.
- Responsive UI 📱: Optimized for all screen sizes and devices.
- Real-Time Messaging ⚡: Enjoy instant updates and uninterrupted communication.
- User Authentication 🔒: Secure sign-up and login functionality.
- Scalable Architecture 📈: Built for high performance and future enhancements.
Follow these steps to set up ChatEZ on your local machine:
-
Clone the Repository 🖥️
Clone the repository from GitHub:git clone https://github.com/Chirag-varu/chatEZ.git
-
Navigate to the Project Folder 📂
Move into the project directory:cd chatEZ
-
Install Dependencies 📦
Usenpm
oryarn
to install the required dependencies:npm install # OR yarn install
-
Set up your
.env
file with:PORT=5001 MONGODB_URI=your-mongodb-uri SECRET_KEY = your_secret_key HTTPS = false CLOUDNARY_CLOUD_NAME = your_cloud_name CLOUDNARY_API_KEY = your_api_key CLOUDNARY_API_SECRET = your_api_secret
-
Start the Development Server 🚀
Run the project locally:npm run dev # OR yarn dev
Open your browser and visit
http://localhost:5173
to access ChatEZ.
We welcome contributions to ChatEZ! Follow these steps to contribute:
-
Fork the Repository 🍴
- Click the Fork button in the top-right corner of the repository page to create your own copy of the repository.
-
Clone Your Fork 🔄
Clone your forked repository to your local machine:git clone https://github.com/<your-username>/chatEZ.git cd chatEZ npm install
-
Create a New Branch 🌱
Create a feature branch to make changes:git checkout -b feature-name
-
Make Changes ✍️
Implement your feature or bug fix and test it locally. -
Stage and Commit Changes 📝
Stage your modified files and commit with a clear message:git add . git commit -m "Describe your changes"
-
Push Changes ⬆️
Push your branch to your forked repository:git push origin feature-name
-
Create a Pull Request 🔃
- Go to the original ChatEZ repository on GitHub.
- Open a pull request from your feature branch and provide a clear description of your changes.
This project is licensed under the MIT License.
Feel free to use, modify, and distribute this project in accordance with the license terms.