{"id":21412597,"url":"https://github.com/the-best-codes/chatter","last_synced_at":"2025-09-23T22:58:42.144Z","repository":{"id":264200200,"uuid":"891836250","full_name":"The-Best-Codes/chatter","owner":"The-Best-Codes","description":"Chatter is a simple, fast, \u0026 local chat","archived":false,"fork":false,"pushed_at":"2025-06-24T03:06:31.000Z","size":774,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-24T03:23:19.044Z","etag":null,"topics":["binary","bun","chat","chat-application","gui","javascript","lan","language","local-area-network","local-development"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/The-Best-Codes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-21T03:21:43.000Z","updated_at":"2025-05-01T18:32:49.000Z","dependencies_parsed_at":"2024-11-22T16:18:40.410Z","dependency_job_id":"dfd61bfc-3183-4662-9b4b-5a85e024835c","html_url":"https://github.com/The-Best-Codes/chatter","commit_stats":null,"previous_names":["the-best-codes/chatter"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/The-Best-Codes/chatter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fchatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fchatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fchatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fchatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-Best-Codes","download_url":"https://codeload.github.com/The-Best-Codes/chatter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fchatter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276662411,"owners_count":25682029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["binary","bun","chat","chat-application","gui","javascript","lan","language","local-area-network","local-development"],"created_at":"2024-11-22T18:11:43.207Z","updated_at":"2025-09-23T22:58:42.124Z","avatar_url":"https://github.com/The-Best-Codes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chatter\n\n\u003cimg src=\"./public/favicon/apple-touch-icon.png\" alt=\"chatter icon\" for=\"cover\" width=\"100\" /\u003e\n\n[![License](https://img.shields.io/github/license/The-Best-Codes/chatter)](https://github.com/The-Best-Codes/chatter/blob/main/LICENSE)\n[![GitHub Stars](https://img.shields.io/github/stars/The-Best-Codes/chatter?style=social)](https://github.com/The-Best-Codes/chatter/stargazers)\n[![GitHub Issues](https://img.shields.io/github/issues/The-Best-Codes/chatter)](https://github.com/The-Best-Codes/chatter/issues)\n\nA real-time chat application built with **Bun**, **WebSocket**, **SQLite**, and **Tailwind CSS**.\n\nView the README on GitHub [here](https://github.com/The-Best-Codes/chatter/) to see this diagram:\n\n```mermaid\ngraph LR\n    subgraph Client\n        A[User Interaction] --\u003e B(UI Components)\n        B --\u003e C{Event Handlers}\n        C --\u003e D[Fetch API]\n        C --\u003e E[WebSocket]\n    end\n\n    subgraph Server\n        F((Bun Server)) --\u003e G{Route Handler}\n        G --\u003e H{Authentication}\n        H -- Session ID --\u003e I[Session Store, SQLite]\n        H --\u003e J{Request Type}\n\n        J -- HTTP Request --\u003e K{Route Logic}\n        K --\u003e L[Database, SQLite]\n        K --\u003e M[Media Manager]\n\n        J -- WebSocket Upgrade --\u003e N[WebSocket Handler]\n        N --\u003e O[Message Handling]\n        O --\u003e L\n        O --\u003e P[Bot Handling]\n        P --\u003e N\n        N -- Status Updates --\u003e L\n\n        subgraph Bots\n            Q[EchoBot]\n            R[TimeBot]\n            S[GreetBot]\n            P --\u003e Q\n            P --\u003e R\n            P --\u003e S\n        end\n    end\n\n    subgraph Database\n        L --\u003e T(Users Table)\n        L --\u003e U(Messages Table)\n        L --\u003e V(Sessions Table)\n        L --\u003e W(User Status Table)\n        I --\u003e V\n    end\n\n    D -- HTTP Requests --\u003e G\n    E -- WebSocket Connection --\u003e N\n\n    M --\u003e X[Media Directory]\n\n    style A fill:#B2DFDB,stroke:#000000,stroke-width:2px,color:#000000\n    style B fill:#E0F7FA,stroke:#000000,stroke-width:1px,color:#000000\n    style C fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style D fill:#E1F5FE,stroke:#000000,stroke-width:1px,color:#000000\n    style E fill:#E1F5FE,stroke:#000000,stroke-width:1px,color:#000000\n\n    style F fill:#81D4FA,stroke:#000000,stroke-width:2px,color:#000000\n    style G fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style H fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style I fill:#E1F5FE,stroke:#000000,stroke-width:1px,color:#000000\n    style J fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style K fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style L fill:#81D4FA,stroke:#000000,stroke-width:2px,color:#000000\n    style M fill:#E1F5FE,stroke:#000000,stroke-width:1px,color:#000000\n    style N fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style O fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style P fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n\n    style Q fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style R fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n    style S fill:#64B5F6,stroke:#000000,stroke-width:1px,color:#000000\n\n    style T fill:#BBDEFB,stroke:#000000,stroke-width:1px,color:#000000\n    style U fill:#BBDEFB,stroke:#000000,stroke-width:1px,color:#000000\n    style V fill:#BBDEFB,stroke:#000000,stroke-width:1px,color:#000000\n    style W fill:#BBDEFB,stroke:#000000,stroke-width:1px,color:#000000\n    style X fill:#E1F5FE,stroke:#000000,stroke-width:1px,color:#000000\n```\n\n## Table of Contents\n\n1.  [Features](#features)\n2.  [Installation](#installation)\n    - [Pre-built Executables](#pre-built-executables)\n      - [Windows](#windows)\n      - [macOS (Darwin)](#macos-darwin)\n      - [Linux](#linux)\n    - [Development Setup](#development-setup)\n    - [Linux Automatic Installation](#linux-automatic-installation)\n3.  [Daytona - Recommended Development](#daytona---recommended-development)\n4.  [Development Server](#development-server)\n5.  [Production Build and Deployment](#production-build-and-deployment)\n6.  [Project Structure](#project-structure)\n7.  [Technologies](#technologies)\n8.  [Environment Variables](#environment-variables)\n9.  [Attributions](#attributions)\n\n## Features\n\n- 🔐 User authentication (signup/login)\n- 💬 Real-time messaging with WebSocket\n- ✍️ Markdown support for messages\n- 📝 Typing indicators\n- 🌓 Dark mode support\n- 🔄 Auto-scroll with smart scroll lock\n- 📱 Responsive design\n\n## Installation\n\n### Pre-built Executables\n\nIf you just want to use Chatter without setting up a development environment, you can download pre-built executables from the [Releases](https://github.com/The-Best-Codes/chatter/releases/latest) page.\n\n\u003e [!NOTE]\n\u003e Choose the correct executable for your operating system and CPU architecture (`modern` for newer CPUs, `base` for older ones).\n\n\u003e [!IMPORTANT]\n\u003e If you see issues with `sharp` when you run the executable, navigate to the directory containing the `chatter` executable and run `npm install sharp`.\n\n#### Windows\n\n1.  Download `windows-modern.zip` (or `windows-base.zip`).\n2.  Right-click and extract the ZIP file.\n3.  Double-click the executable to start (or run from the command line with `./chatter.exe`).\n4.  Open `http://localhost:5177` in your browser.\n\n#### macOS (Darwin)\n\n1.  Download `darwin-modern.zip` (or `darwin-base.zip`).\n2.  Extract the ZIP file.\n3.  Make the file executable and run it:\n    ```bash\n    chmod +x ./chatter \u0026\u0026 ./chatter\n    ```\n4.  Open `http://localhost:5177` in your browser.\n\n#### Linux\n\n1.  Download `linux-modern.tar.xz` (or `linux-base.tar.xz`).\n2.  Extract the archive.\n3.  Make the file executable and run it:\n    ```bash\n    chmod +x ./chatter \u0026\u0026 ./chatter\n    ```\n4.  Open `http://localhost:5177` in your browser.\n\n### Development Setup\n\nIf you want to contribute or modify the application, follow these steps:\n\n\u003e [!NOTE]\n\u003e It's highly recommended to use Daytona for development. This setup is described in detail in the next section.\n\n1.  **Prerequisites:** Ensure you have [Bun](https://bun.sh) v1.1.36 or higher installed.\n2.  **Clone the Repository:**\n    ```bash\n    git clone https://github.com/The-Best-Codes/chatter.git\n    cd chatter\n    ```\n3.  **Install Dependencies:**\n    ```bash\n    bun install\n    ```\n\n### Linux Automatic Installation\n\nIf you are using a debian-based system, you can automate the installation process by running this command in your terminal:\n\n```bash\ncurl -s https://raw.githubusercontent.com/The-Best-Codes/chatter/refs/heads/master/.install_scripts/debian.sh -o install_chatter.sh \u0026\u0026 chmod +x install_chatter.sh \u0026\u0026 ./install_chatter.sh\n```\n\n## Daytona - Recommended Development\n\n\u003e [!TIP]\n\u003e Daytona is the easiest, fastest, and most isolated way to set up your development environment for Chatter. It creates a containerized workspace that includes all the necessary tools and dependencies.\n\n1.  **Install Daytona**: Follow the [Daytona installation guide](https://www.daytona.io/docs/installation/installation/).\n2.  **Create the Workspace**:\n    ```bash\n    daytona create https://github.com/The-Best-Codes/chatter\n    ```\n3.  **Navigate to the Workspace**:\n    ```bash\n    daytona open chatter\n    ```\n4.  **Start the Application**:\n    ```bash\n    bun run dev\n    ```\n\n\u003e [!NOTE]\n\u003e When using Daytona, you can skip the steps in the \"Development Setup\" section.\n\n## Development Server\n\n\u003e [!TIP]\n\u003e If you are not using Daytona, follow this steps to start the development server.\n\nStart the development server with auto-reload:\n\n```bash\nbun run dev\n```\n\nWatch and compile CSS:\n\n```bash\nbun run css:watch\n```\n\n## Production Build and Deployment\n\n### Building for Production\n\nTo prepare the application for production, run:\n\n```bash\nbun run build\n```\n\n### Starting the Production Server\n\nStart the production server:\n\n```bash\nbun run start\n```\n\n### PM2 Deployment\n\nThe project includes PM2 scripts for production deployment:\n\n```bash\nbun run pm2-start    # Start with PM2\nbun run pm2-stop     # Stop PM2 service\nbun run pm2-restart  # Restart PM2 service\nbun run pm2-startup  # Configure PM2 startup on boot\n```\n\n\u003e [!CAUTION]\n\u003e Make sure to configure your production environment variables correctly when deploying with PM2.\n\n## Project Structure\n\n- `/src`\n  - `/db` - Database schema and operations\n  - `/views` - HTML templates\n- `/public`\n  - `/css` - Stylesheets (TailwindCSS)\n  - `/pages` - Client-side JavaScript\n  - `/images` - Static assets\n\n## Technologies\n\n- **Runtime**: [Bun](https://bun.sh)\n- **Database**: SQLite\n- **Styling**: TailwindCSS with Typography plugin\n- **Frontend**: Vanilla JavaScript with WebSocket\n- **Security**: bcryptjs for password hashing\n\n## Environment Variables\n\n- `PORT` - Server port (default: 5177)\n- `SCHEMA_PATH` - Path to SQLite schema file\n\n## Attributions\n\n- [Bun](https://bun.sh)\n- [TailwindCSS](https://tailwindcss.com/)\n- [Markdown Renderer](https://marked.js.org/)\n- [Chat Sound Effect by Universfield | 'New Notification #7'](https://pixabay.com/collections/interface-sounds-23710620/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-best-codes%2Fchatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-best-codes%2Fchatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-best-codes%2Fchatter/lists"}