Skip to main content

About 2 min
crouton

wrap your CRUD in one neat package.

Configure Resources Once, Use Them Over and Over, Naturally

BuildPublishPublish Docscrouton-apicrouton-vuecrouton-forms-vuecrouton-clicreate-crouton

Documentation

⚠️ Work in progress — crouton is still in active development. APIs, schemas, and components may change without notice; use at your own risk until a stable release is published.

A schema-driven CRUD framework for NestJS + Vue. Define your resources once in JSON — crouton handles the rest: API endpoints, data tables, forms, and filters.

Configure resources once. Use them over and over. No boilerplate, just filling.

Packages

PackageDescriptionStatus
@ghentcdh/crouton-apiNestJS library — generates controllers, repositories, and /schemas endpoints from a resource.json🚧 in development
@ghentcdh/crouton-vueVue 3 component library — renders data tables, forms, filters, and views driven by the schemas🚧 in development

How it works

  1. Define your resource in a resource.json file — columns, operations, filters, relations
  2. Register it with crouton-api — fully typed NestJS routes appear automatically
  3. Connect the Vue components — tables, forms, and filters render from the schema with no extra config
{
  "name": "author",
  "route": "authors",
  "model": "author",
  "operations": {
    "findAll": true,
    "findOne": true,
    "create": true,
    "update": true
  },
  "columns": {
    "id": {
      "hiddenInForm": true,
      "idField": true
    },
    "name": {
      "searchable": true,
      "filterable": true
    },
    "bio": {
      "fieldInput": {
        "type": "textarea"
      }
    }
  }
}

That's it. You get a paginated list endpoint, a detail endpoint, create/update with Zod validation, a /schemasresponse the Vue components consume, and a full admin UI — all from that one file.

Installation

# API (NestJS)
pnpm add @ghentcdh/crouton-api

# Vue
pnpm add @ghentcdh/crouton-vue

Development

This is an Nx monorepo with pnpm workspaces.

# Install dependencies
pnpm install

# Build all packages
npx nx run-many -t build

# Typecheck
npx nx run-many -t typecheck

Packages

packages/
  crouton-api/   — NestJS CRUD framework
  crouton-core/  — shared schema & builder logic, published as @ghentcdh/crouton-core
  crouton-vue/   — Vue 3 UI components

crouton-core is published as @ghentcdh/crouton-core. It is bundled into crouton-api and crouton-vue, but can also be used directly for offline schema compilation via parseSchema.

Documentation

The docs site is built with VuePress. Each package documents itself in packages/<name>/docs/; the site is assembled from those files.

# Serve the docs locally
pnpm docs:serve

# Build the docs site
pnpm docs:build

License

This project is licensed under the MIT License. See the LICENSE file for details.

Credits

Bo Vandersteene, Ghent University.

Development by Ghent Centre for Digital Humanities - Ghent University. Funded by the GhentCDH research projects.

GhentCDH