Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.71 KB

README.md

File metadata and controls

99 lines (63 loc) · 2.71 KB

🌐 ChatSphere - Real-time Chat Application

Welcome to ChatSphere! 🎉 This is a real-time chat application built using Sockets.io for live messaging, React for the frontend, and Node.js & Express for the backend. 🚀

✨ Features

  • 🔥 Real-time Messaging: Instant communication with your friends and teams.

  • 🧑‍💻 User Authentication: Includes Register and Login functionality to manage users.

  • 🖼️ Set Avatar: Users can personalize their profile by setting a unique avatar during registration.

  • 🔒 Logout Feature: Easily log out when you're done chatting, ensuring your account is secure.

  • 🛠️ Scalable Backend: Powered by Node.js and Express for fast, scalable service.

  • 📱 Responsive Design: Seamless chat experience across all devices.

🖥️ Tech Stack

  • Frontend: React.js ⚛️
  • Backend: Node.js with Express.js ⚙️
  • Real-time Communication: Socket.io 🟢
  • Styling: CSS / Styled Components 🎨
  • Database: MongoDB🗄️

📸 Screenshots

Here's a sneak peek of ChatSphere in action:

ChatSphere Chat Page

Figure 1: Chat Page of ChatSphere

ChatSphere login Page

Figure 2: Login Page of ChatSphere

ChatSphere register Page

Figure 3: Register Page of ChatSphere

ChatSphere

Demo Video:

chatsphere.mp4

Check live:- https://chat-sphere-silk.vercel.app/

🚀 Getting Started

Follow these instructions to get a copy of ChatSphere up and running on your local machine for development and testing purposes.

📦 Installation

  1. Clone the repository:

    git clone https://github.com/your-username/chatsphere.git
    cd chatsphere
  2. Install dependencies for the backend:

    cd server
    npm install
    
  3. Install dependencies for the frontend:

    cd public
    npm install
    
  4. ⚙️ Running the Application
    Open 2 terminals for better accessibility

    For frontend:

    Go to the public folder and type yarn start to start the frontend

    For backend:

    Go to the server folder and type nodemon index.js to start the backend

    For socket server:

    Ensure your socket server is running alongside the backend.

🌍 Environment Variables:-

To run this project, you will need to add the following environment variables in a .env file in the server directory:

PORT=5000
MONGO_URI=your_mongo_db_connection_string

✉️ Contact:-

GitHub: Ananta2545
Email: [email protected]

Thanks for visiting chatsphere!!.. 🥰🥰