Docs/Getting Started/Quick Start

Quick Start Guide

Get up and running with GoKS in minutes: install the CLI, create a new project, and run your development server.

1. Prerequisites

Make sure you haveGo 1.26.6 or laterinstalled on your machine. You can verify your version with:

go version

2. Install the GoKS CLI

Install thegokscommand-line interface globally using standard Go tooling:

Terminal
bash
go install github.com/misbakhul29/goks@latest

Note: Ensure that$(go env GOPATH)/binis present in your system$PATH.

3. Create a New Application

Usegoks newto scaffold an application with file-system routing, Tailwind CSS v4, and opinionated folder conventions:

Terminal
bash
goks new myapp
cd myapp
go mod tidy

4. Start the Dev Server

Launch the local development environment with instant hot reloading, background Tailwind compilation, and runtime error overlay:

Terminal
bash
goks dev

Open your browser athttp://localhost:3000. Editing any.goxor Go file will trigger instant browser reloads.

5. Add UI Components (Optional)

GoKS includes a shadcn-inspired component CLI generator. Add accessible, pre-styled Tailwind components into your workspace:

Terminal
bash
goks ui add button input card

6. Build for Production

When you are ready to deploy, generate a self-contained single executable with all WebAssembly, templates, and stylesheets embedded:

Terminal
bash
goks build --standalone
Powered byGoKS WASM16 topics