/let-meet

Primary LanguageJavaScript

let-meet

and

Real-Time Chatting Website

Welcome to our Real-Time Chatting Website project! This project aims to provide a platform for users to engage in real-time communication through text-based chat rooms. Whether you're here to contribute, deploy your own instance, or simply learn from the code, this README will guide you through the setup, features, and usage of the project.

Table of Contents

  1. Introduction
  2. Features
  3. Technologies Used
  4. Installation
  5. Usage
  6. Contributing
  7. License

Introduction

Our Real-Time Chatting Website project offers a modern platform for users to create and join chat rooms, engage in real-time text-based conversations, share multimedia content, and customize their profiles. With seamless communication powered by WebSockets, users can connect with others instantly and foster engaging discussions and connections.

Features

  • Real-Time Communication: Utilize WebSockets to enable real-time messaging between users within chat rooms.
  • Multiple Chat Rooms: Users can create and join multiple chat rooms based on different topics or interests.
  • Multimedia Content Sharing: Share images, videos, and other multimedia content within chat rooms.
  • User Authentication: Secure user authentication to ensure privacy and prevent unauthorized access.
  • Customizable Profiles: Users can customize their profiles with avatars, usernames, status messages, etc.
  • Message History: Access chat history within chat rooms to catch up on previous conversations.
  • Responsive Design: Ensures optimal user experience across various devices and screen sizes.

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Backend: Flask (Python)
  • Database: MySQL
  • Real-Time Communication: WebSockets
  • Authentication: Flask-Login
  • ORM: Flask-SQLAlchemy

Installation

To run the Real-Time Chatting Website project locally, follow these steps:

  1. Clone this repository to your local machine:
git clone https://github.com/mederhoo-script/let-meet.git
  1. Navigate to the project directory:
cd let-meet
  1. Install dependencies:
pip install -r requirements.txt

  1. Configure environment variables. Create a .env file in the root directory and add the following variables:

  2. Initialize the MySQL database:

flask db init
flask db migrate
flask db upgrade
  1. Start the Flask development server:
flask run
  1. Visit http://localhost:5000 in your web browser to access the application.

Usage

Once the application is running, users can:

  • Sign up for an account or log in if they already have one.
  • Create new chat rooms or join existing ones.
  • Start chatting with other users in real-time.
  • Share multimedia content within chat rooms.
  • Customize their profiles and preferences.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/improvement).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/improvement).
  5. Create a new pull request.

License

NONE.