ChatBuddy is a full-stack web application designed to facilitate personal interaction through real-time messaging. It provides users with a seamless experience to connect and communicate with each other. This README file serves as a guide to set up and run the application.
Live Deployed Link :- https://chat-buddy-with-socket-io.vercel.app/
- Real-time Messaging: Utilizes Socket.io for instant messaging between users.
- Image Storage: Cloudinary integration for robust image storage and retrieval.
- State Management: Redux ensures proper state management throughout the application.
- Admin Panel: Includes an admin panel for managing users and content.
To run ChatBuddy locally, follow these steps:
-
Clone the repository:
git clone https://github.com/AdityaGoel0320/MERN-CHAT-APP-WITH-SOCKET-IO.git
-
Install dependencies for both frontend and backend:
cd ChatBuddy/frontend npm install cd ../backend npm install
-
Create a
.env
file in the backend directory and add the following configurations:MONGO_URI=mongodb+srv://<username>:<password>@cluster0.ffsn2re.mongodb.net/MernChatApp?retryWrites=true&w=majority JWT_SECRET=<your_jwt_secret_key> ADMIN_SECRET_KEY=<your_admin_secret_key> NODE_ENV=DEVELOPMENT CLIENT_URL=http://localhost:5173 PORT=1111 CLOUDINARY_CLOUD_NAME=<your_cloudinary_cloud_name> CLOUDINARY_API_KEY=<your_cloudinary_api_key> CLOUDINARY_API_SECRET=<your_cloudinary_api_secret>
-
Create a
.env
file in the frontend directory and add the following configuration:VITE_SERVER=http://localhost:1111
-
Run the backend server:
cd ../backend npm start
-
Run the frontend application:
cd ../frontend npm run dev
-
Access ChatBuddy in your browser at
http://localhost:5173
.
Once the application is up and running, users can sign up, log in, and start messaging with other users in real-time. The admin panel allows administrators to manage users and content efficiently.
Live Deployed Link :- https://chat-buddy-with-socket-io.vercel.app/
- MongoDB
- Express.js
- React
- Node.js
- Cloudinary
- Socket.io
- Redux
© 2024 Aditya Goel. All Rights Reserved.