GritGrit
Star

Getting Started

Installation

Get up and running with Grit in minutes. Install the CLI, choose your architecture, and scaffold a production-ready full-stack application.

System Requirements

ToolMin Version
Go1.21+
Node.js18+
pnpm8+
DockerLatest

Install the Grit CLI

01

Install Grit

Use the one-line install script. It detects an existing install and runs grit update (idempotent — no-ops if already on latest); otherwise it downloads the binary from the matching GitHub release for your OS / arch and puts it on PATH.

Prefer Go? go install github.com/MUKE-coder/grit/v3/cmd/grit@latest does the same thing if you have the Go toolchain.

Terminal
# macOS / Linux
curl -fsSL https://gritframework.dev/install.sh | sh


# Windows (PowerShell)
iwr -useb https://gritframework.dev/install.ps1 | iex
02

Create your project

Run grit new and follow the interactive prompts to select your architecture and frontend framework.

Terminal
grit new my-app


? Select architecture:
  > Triple — Web + Admin + API (Turborepo)
    Double — Web + API (Turborepo)
    Single — Go API + embedded React SPA
    API Only — Go API (no frontend)
    Mobile — API + Expo (React Native)


? Select frontend framework:
  > Next.js — SSR, SEO, App Router
    TanStack Router — Vite, fast builds, small bundle
03

Start infrastructure

Start PostgreSQL, Redis, MinIO, and Mailhog with Docker Compose. These services are pre-configured in the generated docker-compose.yml.

Terminal
cd my-app
docker compose up -d
04

Install dependencies & start

Install frontend dependencies and start all development servers. The Go API runs on :8080, web app on :3000, and admin on :3001.

Terminal
pnpm install
pnpm dev

Architecture shortcuts

Skip the interactive prompts with flags:

Terminal
# Triple (default) with Next.js
grit new my-app --triple --next


# Single app with TanStack Router (Vite)
grit new my-app --single --vite


# Double (web + api) with TanStack Router
grit new my-app --double --vite


# API only (no frontend)
grit new my-app --api


# Desktop app (Wails)
grit new-desktop my-app

Default services

Go APIlocalhost:8080

Backend server

Web Applocalhost:3000

Next.js or TanStack

Admin Panellocalhost:3001

Resource management

API Docslocalhost:8080/docs

Auto-generated

GORM Studiolocalhost:8080/studio

Database browser

Mailhoglocalhost:8025

Email testing

Quick StartProject Structure