Getting Started

Build your first ObjectStack application in 5 minutes.

ObjectStack is a protocol, but @objectstack/spec is the reference implementation library that provides the Zod schemas and strict types to build valid metadata.

Initialize your project

You can start from scratch or add ObjectStack to an existing TypeScript project.

mkdir my-app
cd my-app
npm init -y
npm install typescript zod @objectstack/spec
npx tsc --init

Define your first Object

Create a file named src/objects/contact.schema.ts. This is where the power of Zod-First Definition comes in. You get autocomplete and validation out of the box.

import { ObjectSchema, Field } from '@objectstack/spec';

export const Contact = ObjectSchema.create({
  name: 'contact',
  label: 'Contact',
  fields: {
    first_name: Field.text({ label: 'First Name', required: true }),
    last_name: Field.text({ label: 'Last Name', required: true }),
    email: Field.text({ format: 'email' }),
    type: Field.select(['Customer', 'Partner', 'Vendor']),
  },
  enable: {
    api: true,
    audit: true
  }
});

Validate the Protocol

Create a build script src/build.ts to verify your definitions comply with the ObjectStack Protocol.

import { Contact } from './objects/contact.schema';

// This will throw a ZodError if your schema is invalid
const protocol = Contact.parse(Contact);

console.log(`✅ Object '${protocol.name}' is valid ObjectStack Metadata!`);
console.log(JSON.stringify(protocol, null, 2));

Next Steps

Now that you have valid metadata, you can:

Generate SQL: Use the Protocol Compiler (Coming Soon) to generate CREATE TABLE statements.
Generate UI: Feed the JSON into the <ObjectForm /> React component.
Deploy: Push the JSON to an ObjectOS Kernel.

Getting Started

Initialize your project

Define your first Object

Validate the Protocol

Next Steps

On this page