Skip to content

About

The website and documentation of Firenook, a faster drop-in replacement for the Firebase Local Emulator Suite.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

firenook.dev

The website and documentation of Firenook, a drop-in replacement for the Firebase Local Emulator Suite.

Built with Astro and Starlight, written ahead of time into files and served by Cloudflare.

npm install
npm run dev      # http://localhost:4321
npm run build    # into dist/, failing on any broken link between docs pages
npm run check:site  # then every link, anchor, title and description in dist/

A push to main deploys the site to firenook.dev (.github/workflows/deploy.yml); a pull request builds and checks it. The site is static files on Cloudflare; the one address that runs code is /docs/mcp, an MCP server over the docs (src/worker.ts). cloudflare.config.ts and wrangler.config.ts describe it. To deploy by hand, after cf auth login:

npm run build && npm run package && npm run deploy
  • The docs are Markdown in src/content/docs/docs/, the blog in src/content/blog/. Every page needs a title and a description of 160 characters or fewer.
  • The home page's terminal is Firenook's own screen, recorded by scripts/terminal/; its service cards and agent session are a run of the demo project, captured by scripts/capture/.
  • DESIGN.md is the design system; AGENTS.md has the rules for changing the site.

Found a mistake in the docs? Every docs page has an "Edit page" link, and issues are welcome.

License

Apache License 2.0. Firenook is not affiliated with or endorsed by Google; Firebase is a trademark of Google LLC.

About

The website and documentation of Firenook, a faster drop-in replacement for the Firebase Local Emulator Suite.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages