Skip to content

quick-start.mdx

Latest commit

 

History

History
117 lines (91 loc) · 3.59 KB

quick-start.mdx

File metadata and controls

117 lines (91 loc) · 3.59 KB
Raw
title Quick Start
description Get started with ObjectStack in under 5 minutes. Choose your path based on your role and goals.

import { Code, Layers, Palette, Zap } from 'lucide-react';

Welcome to ObjectStack! This quick start guide will help you get up and running based on your role and what you want to accomplish.

Choose Your Path

} title="I want to build an app" href="./quick-start/build-first-app" description="Complete tutorial: Build a task management app in 10 minutes" /> } title="I'm a backend developer" href="./quick-start/backend-developers" description="Learn how to define Objects, Fields, and Business Logic" /> } title="I'm a frontend developer" href="./quick-start/frontend-developers" description="Understand Views, Pages, and UI Components" /> } title="I'm a platform architect" href="./quick-start/architects" description="Deep dive into the protocol architecture and design decisions" />

30-Second Overview

ObjectStack is a metadata-driven protocol that lets you define your entire application—data models, business logic, and UI—as type-safe JSON/TypeScript configurations.

// Define a data model
export const Task = ObjectSchema.create({
  name: 'task',
  label: 'Task',
  fields: {
    title: Field.text({ label: 'Title', required: true }),
    status: Field.select({ 
      label: 'Status',
      options: ['todo', 'in_progress', 'done']
    }),
    due_date: Field.date({ label: 'Due Date' }),
  }
});

That's it! You've just defined a complete data model with:

  • ✅ TypeScript type safety
  • ✅ Runtime validation (via Zod)
  • ✅ Automatic API generation
  • ✅ Database schema migration
  • ✅ Admin UI generation

What Makes ObjectStack Different?

Traditional Approach ObjectStack Protocol
Write Models + Controllers + Views Define metadata once
SQL migrations by hand Auto-generated from schema
Build CRUD APIs manually REST/GraphQL auto-generated
Hardcoded UI components Server-driven UI from JSON
Scattered business logic Declarative rules & workflows

Next Steps

1. Install the package

npm install @objectstack/spec zod

2. Choose your learning path

3. Explore examples

Common Use Cases

Internal Tools & Admin Panels

Build CRUD applications with complex business logic in hours, not weeks.

CRM & ERP Systems

Replicate Salesforce-like functionality with complete customization.

Workflow Automation Platforms

Define approval flows, state machines, and automation rules declaratively.

Multi-tenant SaaS Platforms

One codebase, infinite customizations through metadata configuration.

Need Help?

  • Documentation: You're reading it! Use the search bar above.
  • GitHub Issues: Report bugs or request features
  • Examples: Browse the /examples directory in the repository