Skip to content

Local setup

The app repository is vimcolorschemes/vimcolorschemes.

Requirements:

  • Node.js 24
  • pnpm 11, or corepack enable
  • A local clone of your fork of the app repository

Run:

Terminal window
git clone https://github.com/<you>/vimcolorschemes.git
cd vimcolorschemes
corepack enable
pnpm install

Create .env.local:

DATABASE_URL=file:./database/vimcolorschemes.db

Then start the app:

Terminal window
pnpm dev

Open http://localhost:3000.

The docs repository is vimcolorschemes/docs.

Run:

Terminal window
corepack enable
pnpm install
pnpm dev

Open http://localhost:4321.

The Worker repository is vimcolorschemes/worker.

Requirements:

  • Go, using the version in go.mod.
  • Neovim for preview generation.
  • git for cloning colorscheme repositories during generation.

Create .env from .env.example, then set local development values:

Terminal window
export DATABASE_URL=file:./data/vimcolorschemes.db
export DATABASE_AUTH_TOKEN=
export GITHUB_TOKEN=
export GITHUB_REPOSITORY_COUNT_LIMIT=25

Run one job:

Terminal window
bin/start import --repo morhetz/gruvbox

Read the full stack path before running Worker jobs that should feed the app.