What is Banter?

• A fully functional, real-time, multi-user chat application.
• Runs 100% in the console as a TUI (Text-based User Interface).
• Backend powered by Google Cloud Firestore for live data sync.
• Target Audience: An "open for all" app for simple, fast, and accessible communication.

Core Tech: C# (.NET) | Google Firestore | Terminal.Gui | LiteDB

Installation & Setup

• Platform: Windows 10 / 11
• Installation: Distributed as a pre-compiled executable.
• Requirements:
  • .NET 10 Runtime
  • A stable internet connection
  • Mouse is highly recommended!

Key Features (1/2)

• Real-time Chat: Instant messaging via live Firestore listeners.
• Account System: Full user registration (with validation) and login.
• Group & 1:1 Chatrooms: Automatically handles multi-participant and individual chats.

• Code Example: Real-time Message Listener

  private void StartListener(string chatroom_id)
  {
      CollectionReference messegesRef = db.Collection("Chatrooms")
          .Document(chatroom_id)
          .Collection("messages");
  
      Query query = messegesRef.OrderBy("timestamp");
  
      _listener = query.Listen(callback: OnSnapshotReceived);
  }

Key Features (2/2)

• Robust Profanity Filtering: Custom ProfanityChecker censors messages, including leetspeak.
• Admin & Chat Tools:
  • Message Pinning
  • Admin Controls (Delete Chat, Clear Messages)
  • Group Management (Leave Chat, Rename Chat)
• Modern TUI: Full keyboard and mouse navigation.

Key Features — Code Example

Applying Profanity Filter

// ... inside OnSnapshotReceived ...
if (...)
    senderName = "Unknown User";

string displayName =
    senderId == SessionHandler.UserId ? $"{senderName} (me)" : senderName;

string chatEntry = $"{displayName}: {ProfanityChecker.CensorTextRobust(message)}";
// ...

Data & Storage

A hybrid approach for cloud, local, and static data.

• 1. Google Firestore (Cloud)
  NoSQL database for all live data.
  Stores: Users, Chatrooms, Messages, Admins, Pinned IDs.
• 2. LiteDB (Local Cache)
  Lightweight local Cache.db.
  Stores: Currently caches User objects for faster lookups.
• 3. .txt File Handling (Static)
  Used to load static assets.
  Stores: BanterLogo.txt is read from disk for the login screen.

Firebase Database Schema

{
  "name": "Adrian Seth...",
  "username": "dreeyanzz",
  "email": "adriangwapoz125@...",
  "password": "scarara",
  "chatrooms": [
    "AyELCpLJgYy3TG0JedBH"
  ]
}
            

{
  "chatroom_name": "American Rejects",
  "type": "group",
  "participants": [...],
  "admins": [...],
  "pinned_messages": [...],

  "messages": { (subcollection)
    "{messageId}": {
      "sender_id": "ZzWLD...",
      "text": "asd123123",
      "timestamp": ...
    }
  }
}
            

Database Schema: /Users

Collection: /Users

Database Schema: /Chatrooms

Collection: /Chatrooms

Database Schema: Messages

Subcollection: /Chatrooms/{id}/messages

Challenges & Solutions

• Challenge 1: Testing Real-time Features
  Problem: Slow internet made testing multi-user features difficult.
  Solution: Recruited classmates (Zedric Camilotes, Gabriel Castaneda) for collaborative E2E testing.
• Challenge 2: Firebase Read/Write Limits
  Problem: Firestore quotas can be an issue for a busy chat app.
  Solution: Designed efficient listeners and planned for robust local caching.

Testing & Validation

A multi-layered strategy to ensure stability.

• Method 1: Manual Feature Testing (Solo)
• Method 2: Collaborative E2E Testing (with Zedric & Gabriel)
• Method 3: Real-time Database Validation

Testing (Test Cases)

Limitations & Known Issues

• Heavy Network Reliance: The app requires a constant, stable internet connection. Robust offline caching (for messages) is not yet implemented.
• No Message Editing/Deleting: Users cannot edit or delete individual messages they have sent.
• Basic Admin Controls: Admin powers are limited to deleting the chat or changing the name, not managing participants (e.g., kicking users).

Future Enhancements

(Planned features to mitigate known limitations)

• Enhanced Session Caching
  • Cache participant info & recent messages on login.
  • Reduce Firestore reads.
  • Clear cache on logout.
• New Chat Features
  • Participant Nicknames
  • Read/Seen Indicators
  • Message Editing & Deleting
• New Admin Controls
  • Manage participants (kick, promote)
• New Media Features
  • Video Call Integration

Conclusion & Key Learnings

(1/2) - Asynchronous C#

Essential for managing network requests to Firebase without freezing the UI.

Code Example: Async Login Button Click

private async void OnLogInButtonClicked()
{
    // ... get username/password ...

    logInButton.Text = "Logging in...";
    SetInteractables(false);

    string? user_id = await FirebaseHelper.GetUserIdFromUsername(inputUsername);
    if (user_id == null)
    {
        // ... show error ...
        return;
    }

    // ... get user info, set session, etc. ...
    await SessionHandler.StartChatroomsListener();
}

Conclusion & Key Learnings

(2/2) - Event-Driven Architecture

Used C# events in SessionHandler to decouple code, allowing windows to react to state changes.

Code Example: Defining the Event

public static class SessionHandler
{
    // ... other properties ...
    public static event Action<string?>? CurrentChatroomChanged;
    // ...
}

Code Example: Subscribing to the Event

private Window2()
{
    // ...
    SessionHandler.CurrentChatroomChanged += OnChatroomChanged;
    SessionHandler.IsLoggedInChanged += OnLogInChanged;
    // ...
}

The "Spark"

My Most Impactful Discovery

The most surprising discovery was that a terminal app could be interacted with using a mouse.

That single Terminal.Gui feature was the inspiration for the project. A chat app is hard to navigate with just a keyboard, and this "sparked" the interest to build Banter.