Basic Documentation

Welcome to the official documentation for Basic, a local-first database designed for user-owned data.

Maintaining openapi.json

The file openapi.json should stay in sync with the deployed Admin API. Regenerate it from the live spec (same host as the docs playground):

curl -sS 'https://api.basic.tech/docs/json' -o openapi.json
# optional: pretty-print
python3 -c "import json; p='openapi.json'; d=json.load(open(p)); json.dump(d, open(p,'w'), indent=2)"

When developing against a local admin server, substitute your local base URL and /docs/json.

🚀 Quick Start

To get started with Basic:

1. What is Basic? and Admin & project setup
2. Pick an integration guide:
   • React
   • Next.js
   • REST API

🌟 Key Features

• User-owned Personal Data Stores (PDS)
• Local-first sync for offline support and real-time capabilities
• OAuth 2.0 authentication included

📚 Core Concepts

• Personal data stores
• Local-first sync
• Basic Auth (OAuth)
• Managing permissions

🛠 API reference

• Auth APIs
• Management APIs (projects, users, teams, keys)

💻 SDK reference

• React hooks & provider

🗺 Roadmap

See the roadmap.

🤝 Connect with Us

• Twitter
• GitHub
• Book a Call