Skip to content

README.md

Latest commit

 

History

History
74 lines (54 loc) · 2.14 KB

README.md

File metadata and controls

74 lines (54 loc) · 2.14 KB
Raw

Blank Starter

Minimal ObjectStack environment — a clean slate for building.

Getting started

pnpm install
pnpm dev

The REST API is served at http://localhost:3000/api/v1. Data endpoints require a session — the dev server seeds a login-ready admin (admin@objectos.ai / admin123) on an empty database:

curl -c cookies.txt -X POST http://localhost:3000/api/v1/auth/sign-in/email \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@objectos.ai","password":"admin123"}'

curl -b cookies.txt "http://localhost:3000/api/v1/data/<your_object>"

Layout

  • objectstack.config.ts — environment manifest (objects, API, plugins)
  • src/objects/ — object definitions (one file per object)

Verify your changes

After editing any metadata, run:

pnpm validate     # schema + CEL predicates + widget bindings (no artifact)
pnpm typecheck    # TypeScript types against @objectstack/spec

pnpm validate runs the same gates as pnpm build and catches mistakes that otherwise fail silently at runtime — e.g. a bare done (instead of record.done) in an action predicate that would hide the action on every record. See AGENTS.md for the full convention.

Deploy

The project ships container-ready — the Dockerfile builds your metadata into an artifact and runs it on the official ObjectStack runtime image (ghcr.io/objectstack-ai/objectstack):

# Image only
docker build -t my-app .

# Or the full app + Postgres stack
cat > .env <<EOF
POSTGRES_PASSWORD=$(openssl rand -hex 16)
OS_AUTH_SECRET=$(openssl rand -hex 32)
OS_SECRET_KEY=$(openssl rand -hex 32)
EOF
docker compose up -d
curl -fsS http://localhost:8080/api/v1/health

Bare Node, Kubernetes, reverse-proxy wiring, and the required secrets are covered in Self-Hosted Deployment.

Next steps

  • Add an object: see the objectstack-data skill.
  • Add a view or app: see objectstack-ui.
  • Add a flow or automation: see objectstack-automation.
  • Add an AI agent: see objectstack-ai.

Skills live in skills/ in the ObjectStack framework repo and in the in-IDE assistant catalog.