BCRegistry

Tech

• Framework: Nuxt 3
• UI Library: Nuxt UI v3
• Markdown Renderer: Nuxt Content v3

Development and Contributing

Please review the Code of Conduct and Contributing guidelines before contributing to this project to ensure a positive and productive experience for everyone.

Create a fork and local copy of this repo. Answer Y to create a local clone.

gh repo fork bcgov/bcregistry

Change into the directory and install the packages.

cd bcgov/bcregistry
pnpm install

Startup the development environment.

pnpm run dev

pnpm install also sets up Lefthook pre-commit hooks (gitleaks secret scanning) - no extra setup needed. If a commit is blocked by a false-positive secret match, add an allowlist entry to .gitleaks.toml rather than committing with --no-verify. The gitleaks rules are shared from bcgov/bcregistry-sre and refresh automatically; on Windows run git config --global core.longpaths true once first.

Build and Preview

Build the static site

pnpm run generate

Locally preview the static site

npx http-server .output/public