Community Ox Resources Documentation

Local Development

This project targets Bun 1.3.x for all scripts.

1. Install Bun (Windows PowerShell):

   irm https://bun.sh/install.ps1 | iex

2. Install dependencies: bun install
3. Start the dev server: bun run dev and open http://localhost:3000

Tip: set BUN_INSTALL_CACHE_DIR to reuse dependency caches across CI or multiple local checkouts.

Run bun run lint, bun run typecheck, or bun run analyze for targeted checks. Use bun run prepare to clear local caches (.next/cache, node_modules/.cache) before benchmarking.

Static Export & GitHub Pages

• Build the static site with bun run build. When building for GitHub Pages set the environment variable GITHUB_PAGES=true so the correct base path and asset prefix are applied.
• Preview the export locally by serving the generated out directory. Example on PowerShell: bun run build; bunx serve out.
• Deployments are automated via the GitHub Actions workflow in .github/workflows/deploy.yml, which pushes the static output to the GitHub Pages environment.

License

This project is licensed under the MIT License.