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

Tool	Min Version	Required For	Check
Go	1.21+	API server	`go version`
Node.js	18+	Frontend apps	`node --version`
pnpm	8+	Package management	`pnpm --version`
Docker	Latest	Infrastructure	`docker --version`

Install the Grit CLI

Install Grit

Install the Grit CLI globally using go install. This gives you the grit command anywhere on your system.

Terminal

go install github.com/MUKE-coder/grit/v3/cmd/grit@latest

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

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

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 Start Project Structure