Getting Started
Overview
Every modern application needs a strong foundation: backend authentication, data storage, file management, access control, and dynamic templating. Building these systems from scratch often means spending weeks on repetitive plumbing before your first user signs up. Keeping them running means ongoing infrastructure management that distracts you from building features your users love.
Oblax eliminates that gap. As a cloud development platform, Oblax provides production-ready backend building blocks as composable modules that you wire together using a unified CLI and SDK. You define your data model using local files, push it to the platform, and immediately get a fully hosted, scalable API without writing a single server endpoint.
What Is Oblax?
Oblax is a cloud development platform that provides backend building blocks as composable modules:
| Module | Purpose |
|---|---|
| Forms | ID-based CRUD collections for structured data |
| Bookmarks | ID-based CRUD collections for user references |
| Flux Scripts | Key-based semantic singletons for workflow automation |
| Templates | Key-based semantic singletons for dynamic content |
| ACL | HTTP-key-based route maps for API permissions |
You manage these modules through a unified CLI (obx) and JavaScript/TypeScript SDK. Your local project serves as the single source of truth: any changes you make locally sync directly with the cloud platform, and updates made online mirror seamlessly back to your machine.
The Workflow
Oblax follows a simple, consistent workflow: install, configure, build, deploy.
This guide takes you through every stage of your developer journey. Each section builds naturally on the last, from installing the CLI to making your first authenticated API call and deploying to production. By the end of this guide, you will have a live application with real data flowing through it.
Where to next
| Section | Description |
|---|---|
| Install the CLI | Set up the obx CLI on your system using Homebrew, npm, or binary download |
| Create an Account | Register your platform identity and get your first roles |
| Create a Project | Initialize a project workspace with the /app filesystem model |
| Create Your First App | Scaffold modules and push resources to the platform |
| Run & Deploy | Start the local development server and deploy to production |
| Your First API Call | Authenticate and interact with your data via CLI, SDK, or REST |
| Your First SDK Call | Integrate Oblax into a web or mobile frontend |
| Your First CLI Command | Master the deterministic command grammar and CRUD workflows |