Skip to content

README.md

Latest commit

 

History

History
54 lines (34 loc) · 1.58 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.58 KB
Raw

ChatStream

Welcome to ChatStream, a real-time chat application where users can join different rooms and exchange messages.

Project Structure

This repository is divided into two main components:

  1. Backend: Handles the server-side logic, database interactions, and API endpoints.
  2. Frontend: Manages the client-side interface, user interactions, and real-time updates.

Each component has its own setup instructions provided in their respective README files.

Setup Instructions

Prerequisites

Ensure you have the following installed on your machine:

  • Node.js
  • npm (Node Package Manager)
  • Any other specific requirements listed in the backend and frontend README files

Backend Setup

  1. Navigate to the backend folder: 
    cd backend
  2. Follow the instructions in the backend/README.md to set up and run the backend server.

Frontend Setup

  1. Navigate to the frontend folder: 
    cd frontend
  2. Follow the instructions in the frontend/README.md to set up and run the frontend application.

Running the Application

Once both the backend and frontend are set up and running, you can access the application through your web browser. The frontend will communicate with the backend to facilitate real-time chat functionality.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Feel free to explore, and enjoy real-time chatting with ChatStream!

If you have any questions or need further assistance, please open an issue in this repository.

Thank you for using ChatStream!