happy

(β˜… 23,444)

Mobile and Web client for Codex and Claude Code, with realtime voice, encryption and fully featured

  • .dockerignore
  • .gitignore
  • .mcp.json
  • .npmrc
  • AGENTS.md
  • Dockerfile
  • Dockerfile.server
  • Dockerfile.webapp
  • LICENSE
  • logo.png
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • PRIVACY.md
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/slopus/happy

Downloads the entire project code from GitHub to your computer.

cd happy

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g happy

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… 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 build -t happy .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 happy

Runs the built image as an actual container.

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

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g happy

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd packages/happy-app/src-tauri

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation