Skip to content

QUICKSTART.md

Latest commit

 

History

History
101 lines (72 loc) · 1.77 KB

QUICKSTART.md

File metadata and controls

101 lines (72 loc) · 1.77 KB
Raw

Quick Start Guide

Start the Application

Terminal 1 - Start Server

cd /home/tej/chat-app
PYTHONPATH=/home/tej/chat-app python server/server.py

Terminal 2 - Start Client (User 1)

cd /home/tej/chat-app
PYTHONPATH=/home/tej/chat-app python client/client.py

Terminal 3 - Start Client (User 2)

cd /home/tej/chat-app
PYTHONPATH=/home/tej/chat-app python client/client.py

Quick Command Reference

Setup (Do Once Per User)

> register          # Create account
> login             # Login to account

One-on-One Chat

Quick message:

> send alice Hello there!

Continuous chat:

> chat alice
@alice > Hey!
@alice > How are you?
@alice > /exit

Group Chat

Setup:

> create mygroup    # Create group
> join mygroup      # Join existing group

Send messages:

> gsend mygroup Hello everyone!

Continuous group chat:

> gchat mygroup
#mygroup > Hello team!
#mygroup > Any updates?
#mygroup > /exit

Manage:

> groups            # List your groups
> members mygroup   # See who's in a group
> leave mygroup     # Leave a group

Features

✅ Chat history - All messages saved automatically in chat_history/ folder ✅ Timestamps - Every message shows when it was sent ✅ Continuous chat - Chat without typing usernames every time ✅ Group chat - Create groups and chat with multiple people ✅ Colorful UI - Easy to read with color-coded messages

Tips

  • Use help anytime to see all commands
  • Messages you send appear in green
  • Messages you receive appear with timestamps
  • In continuous chat mode, just type and press Enter
  • Type /exit to leave continuous chat mode
  • All conversations are automatically saved

Enjoy chatting! 🎉