How firenook-dev/firenook works
Firenook is a Rust-based local Firebase-compatible emulator preview. A developer starts a configured suite through the CLI; client SDKs then reach service-specific HTTP/gRPC fronts, which implement Firebase APIs over persistent Firestore state and native Auth, Storage, Rules, Pub/Sub, Tasks, Functions, and Extensions runtimes. Functions execute user JavaScript in supervised Node workers. The repository also includes a browser console and export/import support. README statements establish the product capabilities; several internal links below are dashed because the supplied source excerpts do not show their wiring.
Main entry points: src/lib.rs Suite lifecycle · service.rs Firestore gRPC · disk.rs Disk/WAL store · src/lib.rs Firestore REST
Components 25
Entry and suite
- CLI commands
crates/cli/src/main.rs - Suite control API
crates/suite-front/src/lib.rs - Suite lifecycle
crates/suite-runtime/src/lib.rs
Firestore and rules
- Firestore gRPC
crates/grpc-front/src/service.rs - Firestore REST
crates/rest-front/src/lib.rs - Firestore WebChannel
crates/webchannel-front/src/lib.rs - Query decoding
crates/grpc-front/src/query_codec.rs - Query engine
crates/query-engine/src/query.rs - Rules evaluation
crates/rules-engine/src/ast.rs - Rules request state
crates/rules-runtime/src/request_history.rs
Firebase services
- Auth emulator
crates/auth-front/src/ops/signin.rs - Storage emulator
crates/storage-front/src/lib.rs - Pub/Sub emulator
crates/pubsub-front/src/broker.rs - Cloud Tasks emulator
crates/tasks-front/src/lib.rs - Functions routes
crates/functions-runtime/src/server.rs - Node worker
crates/functions-runtime/src/worker.rs - Extensions runtime
crates/extensions/src/lib.rs
Runtime and state
- Disk/WAL store
crates/core-store/src/disk.rs - Import/export format
crates/export-format/src/entity.rs
Developer console
- Console application
console/src/main.tsx - Console routes
console/src/routeTree.gen.ts - Console API client
console/src/api/client.ts
Other components
- Developer
- Firebase client SDKs
- User JS functions
Connections 27
- Developer → CLI commands: runs commands
README.md - CLI commands → Suite control API: starts suite
- Suite control API → Suite lifecycle: controls lifecycle
- Firebase client SDKs → Firestore gRPC: calls gRPC
- Firebase client SDKs → Firestore REST: calls REST
- Firebase client SDKs → Firestore WebChannel: opens listen
- Firestore gRPC → Query decoding: decodes queries
- Query decoding → Query engine: builds queries
crates/grpc-front/src/query_codec.rs - Firestore gRPC → Query engine: runs pipeline
- Firestore gRPC → Disk/WAL store: reads and writes
- Firestore REST → Disk/WAL store: reads and writes
- Firestore WebChannel → Disk/WAL store: streams changes
- Rules request state → Rules evaluation: evaluates rules
- Firestore REST → Rules request state: checks requests
- Firestore gRPC → Rules request state: checks requests
- Suite lifecycle → Auth emulator: starts service
- Suite lifecycle → Storage emulator: starts service
- Suite lifecycle → Pub/Sub emulator: starts service
- Suite lifecycle → Cloud Tasks emulator: starts service
- Suite lifecycle → Functions routes: starts service
- Functions routes → Node worker: supervises worker
- User JS functions → Node worker: executes in
README.md - Suite lifecycle → Extensions runtime: runs extensions
- Developer → Console application: uses console
- Console application → Console routes: loads routes
console/src/main.tsx - Console routes → Console API client: requests data
- Import/export format → Disk/WAL store: imports and exports