Basefloor Developer Docs
Technical documentation for the Basefloor Hotel Management System platform.
Basefloor Developer Documentation
Welcome to the Basefloor developer hub. This site covers everything engineers need to build, extend, and operate the Basefloor HMS platform.
Platform Overview
Basefloor is a multi-tenant Hotel Management System composed of:
| Component | Stack | Description |
|---|---|---|
| hms-core | Ruby on Rails | REST API backend, database, background jobs |
| web | TanStack Start + React | Primary hotel staff web application |
| marketing | Next.js 15 (App Router) | Public-facing marketing website |
| @hms/ui | shadcn/ui + Tailwind | Shared UI component library |
| @hms/shared | TypeScript | Shared utilities, types, and constants |
Quick Links
Architecture
System design, multi-tenancy model, and tech stack decisions.
Local Development
Get the full stack running on your machine.
API Reference
REST API endpoints, authentication, and request formats.
Data Models
Database schema, relationships, and entity definitions.
Frontend
TanStack Start app structure, routing, and state management.
Deployment
CI/CD pipelines, Rails Kamal deployment, and Cloudflare Pages.
Repositories
| Repo | Description |
|---|---|
flockworks/hms-core | Rails API backend |
flockworks/basefloor-UI | Frontend monorepo (TanStack, Marketing, UI Package) |
flockworks/basefloor-dev-docs | This documentation site |
flockworks/basefloor-product-docs | End-user product documentation |
Getting Help
For engineering questions, open an issue or discussion in the relevant repository. Internal contributors should join the #engineering channel.