crumbleerp/clarity repository overview

services:
  app:
    image: crumbleerp/clarity:latest
    container_name: clarity-app
    ports:
      - "3000:3000"
    environment:
      NUXT_DATABASE_URL: postgresql://clarity:clarity@postgres:5432/clarity
      NUXT_PUBLIC_DATASET: production
      NUXT_ROOT_USERNAME: admin
      NUXT_ROOT_PASSWORD: admin
      NUXT_SESSION_SECRET: some-random-secret-at-least-32-chars-long
      NUXT_PUBLIC_API_BASE_URL: "https://example.com"
      NUXT_S3_ENDPOINT: https://s3.example.com
      NUXT_S3_REGION: us-east-1
      NUXT_S3_BUCKET: clarity-bucket
      NUXT_S3_ACCESS_KEY: access-key
      NUXT_S3_SECRET_KEY: secret-key
      NUXT_S3_PUBLIC_URL: https://cdn.example.com
    depends_on:
      postgres:
        condition: service_healthy
    restart: unless-stopped

  postgres:
    image: postgres:17-alpine
    container_name: clarity-postgres
    volumes:
      - postgres-data:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: clarity
      POSTGRES_PASSWORD: clarity
      POSTGRES_DB: clarity
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U clarity -d clarity"]
      interval: 5s
      timeout: 5s
      retries: 10
    restart: unless-stopped

volumes:
  postgres-data:

docker compose up -d

npm install @crumbleerp/clarity

import { createClient, groq } from '@crumbleerp/clarity'

const client = createClient({
  endpoint: 'https://cms.example.com',  // your Clarity instance
  dataset: 'production'
})

// Fetch all posts
const posts = await client.fetch(groq`*[_type == 'post'] | order(publishedAt desc)[0...10]`)

// Fetch with parameters
const post = await client.fetch(
  groq`*[_type == 'post' && slug.current == $slug][0]`,
  { slug: 'hello-world' }
)

console.log(post.title)

docker run -d \
  -p 3000:3000 \
  -e NUXT_DATABASE_URL=postgresql://user:pass@host:5432/clarity \
  -e NUXT_ROOT_USERNAME=admin \
  -e NUXT_ROOT_PASSWORD=change-me \
  -e NUXT_SESSION_SECRET=your-random-secret-at-least-32-chars \
  crumbleerp/clarity:latest

[
  {
    "name": "post",
    "title": "Blog Post",
    "schema_type": "document",
    "fields": [
      { "name": "title", "type": "string", "title": "Title", "required": true },
      { "name": "slug", "type": "slug", "title": "Slug" },
      { "name": "body", "type": "markdown", "title": "Body" },
      { "name": "publishedAt", "type": "datetime", "title": "Published At" },
      { "name": "author", "type": "reference", "title": "Author", "referenceTo": ["author"] }
    ]
  }
]

import { createClient, defineType, defineField, groq } from '@crumbleerp/clarity'

const client = createClient({
  endpoint: 'https://your-clarity-instance.com',
  dataset: 'production'
})

// Define a schema
const post = defineType({
  name: 'post',
  title: 'Blog Post',
  fields: [
    defineField({ name: 'title', type: 'string', title: 'Title' }),
    defineField({ name: 'body', type: 'markdown', title: 'Body' })
  ]
})

// Query with GROQ
const posts = await client.fetch(groq`*[_type == 'post'] | order(publishedAt desc)`)

GET /v1/data/query/{dataset}?query=*[_type == "post"]

POST /v1/data/mutate/{dataset}
Content-Type: application/json

{
  "mutations": [
    { "create": { "_type": "post", "title": "New Post" } }
  ]
}