everything.dev

Module Federation monorepo with runtime-loaded configuration, demonstrating every-plugin architecture, everything-dev api & cli, and NEAR Protocol integration.

Built with Tanstack Start, Hono.js, oRPC, better-auth, and rsbuild.

Quick Start

bun install             # Install dependencies
bos dev --host remote   # Start development (typical workflow)

This will start serving the UI, the API, and mounting it on a universally shared (remote) HOST application's build.

Visit through the host: http://localhost:3000 Visit the api: http://localhost:3000/api

This maintains a flexible, well-typed architecture that connects the entirity of the application, it's operating system, and a cli to interact with it. It is a perpetually in-development model for the Blockchain Operating System (BOS)

CLI Commands

everything-dev is the canonical runtime package and CLI. bos is a command alias for the same tool. See .agent/skills/bos/SKILL.md for the full reference.

Development

everything-dev dev --host remote   # Remote host, local UI + API (typical)
everything-dev dev --ui remote     # Isolate API work
everything-dev dev --api remote    # Isolate UI work
           |/ --proxy              # Use a proxy
everything-dev dev                 # Full local, client shell by default

# `bos` is an alias for the same commands
bos dev --ssr                      # Opt into local SSR

Production

everything-dev start --no-interactive   # All remotes, production URLs

Build & Publish

bos build               # Build all packages (updates bos.config.json)
bos publish             # Publish config to the temporary dev.everything.near registry
bos publish --deploy    # Build/deploy all workspaces, then publish
bun run publish         # Same publish command via root script
bos sync                # Sync from production (every.near/everything.dev)

Project Management

bos create project <name>   # Scaffold new project
bos info                    # Show configuration
bos status                  # Check remote health
bos clean                   # Clean build artifacts

Development Workflow

Making Changes

• UI Changes: Edit ui/src/ → hot reload automatically → publish with bos publish --deploy
• API Changes: Edit api/src/ → hot reload automatically → publish with bos publish --deploy
• Host Changes: Edit host/src/ or bos.config.json → publish with bos publish --deploy

Before Committing

Always run these commands before committing:

bun test        # Run all tests
bun typecheck   # Type check all packages
bun lint        # Run linting (see lint setup below)

Changesets

We use Changesets for versioning:

When to add a changeset:

• Any user-facing change (features, fixes, deprecations)
• Breaking changes
• Skip for: docs-only changes, internal refactors, test-only changes

Create a changeset:

bun run changeset
# Follow prompts to select packages and describe changes

The release workflow (.github/workflows/release.yml) handles versioning and GitHub releases automatically on merge to main.

Git Workflow

See CONTRIBUTING.md for detailed contribution guidelines including:

• Branch naming conventions
• Semantic commit format
• Pull request process

Documentation

• AGENTS.md - Quick operational guide for AI agents
• CONTRIBUTING.md - Contribution guidelines and git workflow
• LLM.txt - Deep technical reference for implementation
• API README - API plugin documentation
• UI README - Frontend documentation
• Host README - Server host documentation

Documentation Purpose:

• README.md (this file) - Human quick start and overview
• AGENTS.md - Agent operational shortcuts
• CONTRIBUTING.md - How to contribute (branch, commit, PR workflow)
• LLM.txt - Technical deep-dive for implementation details
• Package READMEs (api/, ui/, host/) - Package-specific details

Architecture

Module Federation monorepo with runtime-loaded configuration:

┌─────────────────────────────────────────────────────────┐
│                  host (Server)                          │
│  Hono.js + oRPC + bos.config.json loader                │
│  ┌──────────────────┐      ┌──────────────────┐         │
│  │ Module Federation│      │ every-plugin     │         │
│  │ Runtime          │      │ Runtime          │         │
│  └────────┬─────────┘      └────────┬─────────┘         │
│           ↓                         ↓                   │
│  Loads UI Runtime          Loads API Plugins            │
└───────────┬─────────────────────────┬───────────────────┘
            ↓                         ↓
┌───────────────────────┐ ┌───────────────────────┐
│    ui/ (Runtime)      │ │   api/ (Plugin)       │
│  React + TanStack     │ │  oRPC + Effect        │
│  ui/src/app.ts        │ │  remoteEntry.js       │
└───────────────────────┘ └───────────────────────┘

Key Features:

• ✅ Runtime Configuration - All URLs from bos.config.json (no rebuild needed)
• ✅ Independent Deployment - UI, API, and Host deploy separately
• ✅ Type Safety - End-to-end with oRPC contracts
• ✅ UI Runtime Boundary - everything-dev/ui/client and /server own router/runtime glue
• ✅ CDN-Ready - Module Federation with Zephyr Cloud

Configuration

All runtime configuration lives in bos.config.json:

{
  "account": "dev.everything.near",
  "domain": "everything.dev",
  "repository": "https://github.com/nearbuilders/everything-dev",
  "testnet": "dev.allthethings.testnet",
  "plugins": {
    "template": {
      "development": "local:plugins/_template"
    }
  },
  "app": {
    "host": {
      "name": "host",
      "development": "local:host",
      "production": "https://..."
    },
    "ui": {
      "name": "ui",
      "development": "local:ui",
      "production": "https://...",
      "ssr": "https://..."
    },
    "api": {
      "name": "api",
      "development": "local:api",
      "production": "https://...",
      "variables": {},
      "secrets": []
    }
  }
}

The temporary publish registry currently points at dev.everything.near, and bos publish --deploy is the release path when you want Zephyr URLs refreshed first.

Railway

Use the repo Dockerfile for the service, and treat the GHCR image as the deployable artifact.

• Image source: ghcr.io/<lowercased github.repository>:latest
• Config updates: bos.config.json publish workflow; restart/redeploy is provider-specific
• Code updates: GHCR build workflow

Required runtime vars:

• BOS_ACCOUNT=dev.everything.near
• GATEWAY_DOMAIN=everything.dev

See .agent/skills/bos/docs/types.md for the complete schema.

Lint Setup

This project uses Biome for linting and formatting:

# Check linting
bun lint

# Fix auto-fixable issues
bun lint:fix

# Format code
bun format

Biome is configured in biome.json at the project root. Generated files (like routeTree.gen.ts) are automatically excluded.

Tech Stack

Frontend:

• React 19 + TanStack Router (file-based) + TanStack Query
• Tailwind CSS v4 + shadcn/ui components
• Module Federation for microfrontend architecture

Backend:

• Hono.js server + oRPC (type-safe RPC + OpenAPI)
• every-plugin architecture for modular APIs
• Effect-TS for service composition

Database & Auth:

• SQLite (libsql) + Drizzle ORM
• Better-Auth with NEAR Protocol support

Related Projects

• [every-plugin](https://github.com/near-everything/[every-plugin](https://plugin.everything.dev/)) - Plugin framework for modular APIs
• near-kit - Unified NEAR Protocol SDK
• better-near-auth - NEAR authentication for Better-Auth

License

MIT