Development environment
FloCafe source development requires Node.js 22 or later. Clone the repository, run npm install, then npm run dev.
Developer documentation · FloCafe
FloCafe Developer Documentation
Development setup, architecture, APIs, database details, integrations, and contribution guides for FloCafe.
Audience
For people building, testing, and maintaining FloCafe.
This section is for developers and maintainers. For restaurant setup, printers, KDS, backups, and operational troubleshooting, use the FloCafe Help Center.
Architecture and project structure
The repository describes an Electron main process, Express API and WebSocket server, standalone KDS server, SQLite database, printing, and a Next.js renderer using React and Zustand.
Read architecture overviewDatabase and migrations
FloCafe uses local SQLite data, explicit schema migrations, pre-migration backups, and manual restore tools. Treat the repository’s migration and backup code as the source of truth.
Inspect database sourcesAPIs and integrations
HTTP, WebSocket, Google Drive backup, WhatsApp bill delivery, cloud-connected reporting, and tax-pack contracts are documented in the repository as they evolve.
Read API referencePrinting and KDS internals
ESC/POS rendering, printer adapters, document contracts, station routing, and KDS behavior belong in the technical repository docs—not in operator troubleshooting.
Read printing architectureTesting, packaging, and releases
Use the repository scripts for linting, builds, the test suite, platform packaging, and release procedures. Do not infer compatibility from this overview.
Read release processContributing
Small fixes, documentation improvements, and focused tests can start freely. New features, schema changes, and architectural refactors require maintainer discussion.
Read contributing guideSecurity reporting
Use the repository’s security policy or private maintainer contact for vulnerabilities. Do not disclose credentials, customer data, tokens, or exploitable details in a public issue.
Read security reporting policySource of truth
Detailed technical documentation stays with the code.
These links intentionally point to exact GitHub documents so implementation details can be updated with the code that governs them. See the FloCafe docs directory, issues, and releases for current project state.