Skip to content

README.md

Latest commit

 

History

History
207 lines (160 loc) · 6.66 KB

README.md

File metadata and controls

207 lines (160 loc) · 6.66 KB

BetterBase Documentation

Comprehensive documentation for the BetterBase platform, covering all packages, modules, and development workflows.

Table of Contents

Documentation Structure

The documentation is organized into logical sections for easy navigation:

/docs
├── getting-started/           # Getting started guides
│   ├── installation.md
│   ├── quick-start.md
│   ├── your-first-project.md
│   └── configuration.md
├── features/                  # Feature documentation
│   ├── authentication.md
│   ├── database.md
│   ├── storage.md
│   ├── realtime.md
│   ├── graphql.md
│   ├── functions.md
│   ├── webhooks.md
│   └── rls.md
├── guides/                    # Development guides
│   ├── deployment.md
│   ├── production-checklist.md
│   ├── monitoring.md
│   ├── scaling.md
│   ├── security-best-practices.md
│   └── provider-capabilities-and-rollout.md
├── api-reference/             # API documentation
│   ├── client-sdk.md
│   ├── cli-commands.md
│   ├── rest-api.md
│   └── graphql-api.md
├── examples/                  # Example applications
│   ├── todo-app.md
│   ├── chat-app.md
│   ├── blog.md
│   └── ecommerce.md
├── core/                      # Core SDK documentation
│   ├── overview.md
│   ├── auto-rest.md
│   ├── branching.md
│   ├── config.md
│   ├── functions.md
│   ├── graphql.md
│   ├── logger.md
│   ├── middleware.md
│   ├── migration.md
│   ├── providers.md
│   ├── realtime.md
├── client/                    # Client SDK documentation
│   ├── overview.md
│   ├── client.md
│   └── realtime.md
├── cli/                       # CLI documentation
│   └── overview.md
├── templates/                 # Template documentation
│   └── overview.md
└── test-project/              # Test project documentation
    └── overview.md

Getting Started

New to BetterBase? Start here:

  1. Installation - Install Bun and BetterBase CLI
  2. Quick Start - Get running in 5 minutes
  3. Your First Project - Build a complete application
  4. Configuration - Customize your setup

Features

Learn about all BetterBase features:

Guides

Development guides for production:

API Reference

Detailed API documentation:

Examples

Complete example applications:

  • Todo App - Simple todo list with real-time sync
  • Chat App - Real-time messaging with presence
  • Blog - Blog with posts, comments, categories
  • E-commerce - Store with cart, orders, payments

Prerequisites

  • Bun (v1.0+)
  • Git
  • Node.js (v18+ for some optional tools)

Installation

# Clone the repository
git clone https://github.com/betterbase/betterbase.git
cd betterbase

# Install dependencies
bun install

First Steps

  1. Review the Installation Guide
  2. Follow the Quick Start
  3. Build your first project with the Your First Project guide
  4. Explore Examples for complete applications

Contributing

We welcome contributions to improve the documentation! To contribute:

  1. Fork the repository
  2. Make your changes to the appropriate markdown files in /docs
  3. Ensure your changes are clear, accurate, and follow the existing style
  4. Submit a pull request with a clear description of your changes

Documentation Guidelines

  • Use clear, concise language
  • Provide code examples where appropriate
  • Include links to related documentation
  • Mark deprecated features clearly
  • Keep examples up-to-date with current code
  • Follow Markdown best practices

Reporting Issues

If you find errors or omissions in the documentation:

  • Check if the issue has already been reported
  • Create a new issue with details about the problem
  • Include the documentation page and section
  • Suggest improvements if possible

Versioning

This documentation corresponds to the current version of the BetterBase platform. For specific version documentation:

  • Check the git tags for released versions
  • Refer to the CHANGELOG.md for version-specific changes
  • Documentation for older versions is available in the git history

Self-Hosted Deployment

BetterBase can be self-hosted on your own infrastructure. See SELF_HOSTED.md for detailed documentation on:

  • Docker-based deployment
  • Admin dashboard configuration
  • Device authentication for CLI
  • Admin API usage

Quick start:

# Clone and start
docker-compose -f docker-compose.self-hosted.yml up -d

# Login to self-hosted instance
bb login --url https://your-instance.com

License

This documentation is part of the BetterBase platform and is licensed under the MIT License.

© 2026 BetterBase LLC. All rights reserved.