/talk_wave

An app for user-to-user conversations

Primary LanguageJavaScriptMIT LicenseMIT

ChatApp

A straightforward group chat application that allows users to engage in real-time conversations within public or private rooms.

ChatApp Screenshot

Features

  • Real-time Group Chatting: Engage in lively discussions with multiple users in a single room.
  • Public and Private Rooms: Join open public rooms for broad discussions or create private rooms for confidential chats.

Installation

  1. Clone the repository:

    git clone https://github.com/suhy-jang/talk_wave.git
  2. Navigate to the project directory:

    cd talk_wave
  3. Install the required dependencies:

    npm install
  4. Set Up the Server:
    Before running the chat application, ensure you have the server set up and running. Follow the instructions in the talk_wave_server repository. Make sure the server is running on port 4000.


  5. Set Up Environment Variables:
    Create a .env.development file at the root of the project and set up the necessary variables:

    REACT_APP_API_URL='http://localhost:4000'
  6. Start the application:

    npm start

The application should now be running on http://localhost:3000/.

Usage

  1. Registration: Sign up with a username and password to start joining rooms.
  2. Join/Create a Room: Browse through available public rooms or create a private one.
  3. Invite Users to a Private Room: Generate and share an invite key for exclusive room access.
  4. Messaging: Type into the input field and press Enter to send your message.

License

This project is under the MIT License. Check out the LICENSE for more details.