Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.51 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.51 KB
Raw

LiveChat

Welcome to LiveChat, a chat application for connecting with others on different servers.

Features

  • Real-time messaging with other users
  • Ability join chat room (Soon Users will be able to create their own rooms)
  • Emoji support

Setup

To get started with LiveChat, follow these steps:

  1. Download the files from our GitHub repository.
  2. Fill out the configuration file with your server information. This file is located at /config.json.
  3. Install the necessary dependencies by running npm i in your terminal.
  4. Start the application by running node . in your terminal.

Configuration

Before you can start using LiveChat, you need to configure it with your server information. Open the /config.json file and fill in the following fields:

  • ws: The websocket of your server.
  • mongo: The mongo database to use for the server.

Usage

Once you have LiveChat up and running, join the chat room and start messaging other users. Click enter to send a message to the chat.

Video

Check out our demo video to see LiveChat in action:

Contributing

We welcome contributions to LiveChat! To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Make your changes and commit them.
  4. Push your changes to your fork.
  5. Submit a pull request to the main repository.

License

LiveChat is licensed under the MIT License. See the LICENSE file for more information.