Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.58 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.58 KB

ChatRoom: A Real-Time Chat Application

ChatRoom Screenshot

Introduction

Welcome to ChatRoom! This is a real-time chat application built using Flask, Flask-SocketIO, and JavaScript. The app allows users to join a chat room, send text messages, and share images in real-time. It also features an admin panel for managing users, banning, and kicking them from the chat room.

Features

  • Real-Time Chat: Send and receive messages instantly with other users in the chat room.
  • Image Sharing: Easily share images with other users by uploading them from your device.
  • User Management: The admin panel allows administrators to view connected users, ban, and kick them from the chat room.
  • Banned Users List: The admin panel also displays a list of banned users for easy reference.
  • Responsive Design: The application is designed to be responsive, ensuring a great user experience on devices of all sizes.

Technologies Used

  • Flask: A lightweight web framework for Python, used to build the backend of the application.
  • Flask-SocketIO: A Flask extension that adds WebSocket support, enabling real-time communication between the server and clients.
  • JavaScript: Used to handle user interactions and update the chat interface in real-time.
  • HTML5 & CSS3: Used to design and structure the user interface, ensuring a visually appealing and intuitive experience.

Getting Started

To get started with ChatRoom, follow these simple steps:

  1. Clone the repository:
git clone https://github.com/your-username/chatroom.git
  1. Install the required packages:
pip install -r requirements.txt
  1. Run the application:
python app.py
  1. Open your web browser and navigate to http://localhost:5000 to join the chat room.

For Admin Panel

  1. Open your web browser and navigate to http://localhost:5000/admin

Contributing

We welcome contributions from the community! If you'd like to contribute to ChatRoom, please submit a pull request with your proposed changes.

License

ChatRoom is licensed under the MIT License.

Acknowledgements

  • Inspiration for the chat interface design was taken from various sources, including Pinterest.
  • The project was created by Jztchl

ChatRoom Screenshot