marchat

(β˜… 133)

Terminal chat for developers: Go WebSocket server + Bubble Tea TUI client, optional E2E, reactions, DMs, channels, plugins, files, code snippets, admin UI. Backends: SQLite, PostgreSQL, or MySQL. Self-hosted.

  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .golangci.yml
  • ARCHITECTURE.md
  • build-release.ps1
  • CHANGELOG.md
  • CLIENT_HOOKS.md
  • CODE_OF_CONDUCT.md
  • config.example.json
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • docker-compose.proxy.yml
  • docker-compose.yml
  • Dockerfile
  • entrypoint.sh
  • env.example
  • go.mod
  • go.sum
  • install.ps1
  • install.sh
  • LICENSE
  • NOTIFICATIONS.md
  • PACKAGING.md
  • PLUGIN_ECOSYSTEM.md
  • PROTOCOL.md
  • QUICKSTART.md
  • README.md
  • ROADMAP.md
  • SECURITY.md
  • server_config.example.json
  • test.ps1
  • test.sh
  • TESTING.md
  • themes.example.json
  • THEMES.md

# Installation Guide

1. Get the code
git clone https://github.com/Cod-e-Codes/marchat

Downloads the entire project code from GitHub to your computer.

cd marchat

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Scoop A package manager for Windows.
brew tap cod-e-codes/marchat

Registers this project's repository (tap) with Homebrew.

brew install marchat

Installs the pre-built package via Homebrew β€” no source build required.

scoop install marchat

Installs directly via Scoop (Windows).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull codecodesxyz/marchat:v1.3.5

Type this command into your terminal and run it.

docker run -d -p 8080:8080 \

Runs the built image as an actual container.

docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build -o marchat-server ./cmd/server

Compiles the Go program into an executable.

go build -o marchat-client ./client

Compiles the Go program into an executable.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation