Skip to content

Getting started

Installation

Set up Go, Node, dependencies, and a local database.

Installation

Requirements: Go 1.27.3+, Node 24+, npm, and a Google OAuth Web application.

Terminal
cp .env.example .env
npm ci
go run ./cmd/app key:generate
npm run build
go run ./cmd/app migrate
go run ./cmd/app

Copy the generated key into APP_KEY in .env. The app runs at http://localhost:3000. Google sign-in is required locally too. For live reload, install github.com/AlexGalhardo/vukem/cmd/vukem@v0.37.0 and run vukem serve.

Local development uses SQLite; PostgreSQL is recommended in production. MAIL_MAILER=array stores messages in memory during tests.