-
Notifications
You must be signed in to change notification settings - Fork 0
Home
"Empty your mind, be formless. Shapeless, like water." — Bruce Lee
Welcome to the official documentation for LocalBase, the open-source, self-hosted Backend-as-a-Service (BaaS) designed to bring calm and fluidity to your local development workflow.
Navigate through our core documentation to understand how LocalBase flows:
Start here to understand the "Why" and "What".
- Vision & Philosophy: Why we chose "Water" over Fire and Electricity.
- User Stories: Who is this for? (The Solo Dev & The Home Labber).
- Roadmap: Current features (Milestone 1) and future plans.
2. 🏗️ System Architecture
For the Engineers: How the pieces fit together.
- Clean Architecture: Understanding our Repo -> Service -> Handler layers.
- Monorepo Structure: How Frontend and Backend live together.
- Tech Stack: Deep dive into Golang, Gin, GORM, and React.
3. 💾 Database Schema
The Data Structure.
- Schema Diagrams: Visualizing what the database structure look like.
- Column and constraint: Information about columns inside each table.
4. 🔌 Development Standard
For developer who want to contribute
- Project Layout: Full folder structure of the project.
- Commit and branch naming: naming convention for commits and branch.
- Standard API Response: JSON structure for response .
In the current landscape of BaaS, we have "Fire 🔥" and "Electricity ⚡". Both are powerful, but they can be volatile—costing money or requiring internet dependency.
LocalBase is Water.
- Calm: No anxiety about usage limits or billing shocks.
- Essential: It runs on your hardware, sustaining your apps locally.
- Fluid: Adaptable to any environment, from a high-end Mac to a humble Raspberry Pi.
| Component | Technology |
|---|---|
| Backend | Golang 1.25 + Gin Gonic |
| Database | PostgreSQL + GORM |
| Frontend | React + TypeScript + Vite |
| Styling | Tailwind CSS + Shadcn UI |
| Auth | JWT + HttpOnly Cookies + Bcrypt |
We welcome fellow developer to contribute! Please check and review the Development standard to maintain code consistency.
Made with 💙 by the Juna
This is my first ever "kinda" big project, so sorry if there is something wrong with the planning or my coding habit. I'm open for any type of critics :)