Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tusharpamnani/chat-room
A simple chat room application developed using Rust and Rocket, a web framework for Rust.
https://github.com/tusharpamnani/chat-room
project
Last synced: 30 days ago
JSON representation
A simple chat room application developed using Rust and Rocket, a web framework for Rust.
- Host: GitHub
- URL: https://github.com/tusharpamnani/chat-room
- Owner: tusharpamnani
- License: mit
- Created: 2024-01-05T13:28:35.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-01-05T13:41:21.000Z (12 months ago)
- Last Synced: 2024-04-22T05:33:41.386Z (9 months ago)
- Topics: project
- Language: JavaScript
- Homepage: https://chat-room-alpha-five.vercel.app
- Size: 21.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rocket Chat Room Application
## Overview
This is a simple chat room application built with the [Rocket](https://rocket.rs/) web framework in Rust. The application allows users to post messages to chat rooms and view real-time updates using server-sent events (SSE).
## Features
- **Chat Messages:** Users can post messages to specific chat rooms.
- **Real-Time Updates:** Chat messages are broadcasted to clients in real-time using SSE.
- **Simple UI:** The application includes a minimalistic user interface for posting and viewing messages.
## Prerequisites
Before running the application, make sure you have the following installed:
- [Rust](https://www.rust-lang.org/): The programming language used to build the application.
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/tusharpamnani/Chat-Room.git
cd Chat-Room
```
2. Build and run the application:
```bash
cargo run
```
3. Open your web browser and navigate to [http://localhost:8000](http://localhost:8000) to access the chat room.
## Usage
- **Posting Messages:** Enter your username, select a chat room, and type your message. Click the "Send" button to post your message.
- **Real-Time Updates:** Open multiple browser tabs to the same chat room to see real-time updates as messages are posted.
## Project Structure
- **src/main.rs:** Main entry point for the Rocket application. This also defines the routes, handlers, and state.
- **static/:** Directory containing static files for the frontend.
- **index.html:** HTML file for the main page.
- **reset.css:** CSS file for resetting default styles.
- **style.css:** CSS file for styling the chat room.
- **script.js:** JavaScript file for client-side functionality.
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the application.
## License
This project is licensed under the [MIT License](LICENSE).