Skip to content

flowithin/MChat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MChat logo


🟦 MChat - Rust Chat App with AI Assistant

A lightweight, terminal-based chat application built from scratch using Rust's TcpStream. Features a built-in AI assistant triggered via @AI.


🎥 Demo

MChat Demo


✨ Features

  • 🛠 Built using low-level Rust networking primitives (TcpListener, TcpStream)
  • 💬 Real-time chat across multiple clients
  • 🤖 AI Assistant: Mention @AI in your message to invoke an intelligent assistant
  • ⚡ Blazing fast and memory-safe thanks to Rust
  • 🎓 University of Michigan inspired design

🚀 Getting Started

Prerequisites

  • Rust (>=1.70)
  • Cargo

Installation

git clone https://github.com/yourusername/mchat.git
cd mchat
cargo build --release

🖥️ Usage

Start the server

cargo run --bin server

Start a client

In a new terminal:

cargo run --bin client

Connect multiple clients in different terminals to simulate multi-user chat.


🧠 Using the AI Assistant

To invoke the AI assistant, simply type a message like:

@AI What's the weather today?

The assistant will respond directly in the chat with relevant information.


🏫 Inspired By

This project was built with ❤️ at the University of Michigan. Go Blue! 💙💛 Logo courtesy of Wikipedia Commons.


📄 License

MIT License


🤝 Contributions

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.


📬 Contact

Feel free to reach out via issues or email me at jtwuuuuu@umich.edu.


Let me know if you'd like:

  • A custom UMich-style logo for MChat (I can generate one for you).
  • Embedded YouTube demo markdown if you're hosting it there.
  • The Cargo.toml file and module layout to match this documentation.

About

a multi user chat web app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published