Skip to content

Latest commit

 

History

474 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cabloy Start

License: MIT Documentation

Cabloy Start is a public, MIT-licensed business-system edition baseline for Cabloy, a coordinated Node.js fullstack system.

  • Vona is Cabloy's backend framework and runtime layer.
  • Zova is Cabloy's frontend framework and application layer.
  • Cabloy Start provides the cabloyStartAdmin and cabloyStartWeb SSR flavors with a Vuetify UI layer.

Cabloy Basic and Cabloy Start share the Cabloy architecture, but intentionally differ in their UI layers, frontend flavors, modules, SSR baselines, and project assets. Create a Cabloy Basic project with npm create cabloy; clone this repository to use Cabloy Start.

Prerequisites

  • Git
  • Node.js >=24.4.0
  • pnpm >=11.5.2
  • Redis >=7.2.6
  • One documented development database baseline: SQLite, MySQL >=8, or PostgreSQL >=16

SQLite setups using better-sqlite3 may require a working native build toolchain for node-gyp.

Get started

git clone https://github.com/cabloy/cabloy-start.git
cd cabloy-start
npm run init

npm run init installs dependencies, prepares generated local configuration, initializes the Vona and Zova workspaces, and generates the required frontend and backend artifacts. It is more than a package-install command.

Editions

Cabloy is available through two complete project baselines, each maintained in its own repository:

  • Cabloy Basic — the public framework and reference edition, licensed under MIT, with a DaisyUI + Tailwind CSS UI layer and an e-commerce-oriented demonstration suite.
  • Cabloy Start — a public starter edition, licensed under MIT, with a Vuetify UI layer and built-in system-management and authorization demonstrations.

Both editions share Cabloy’s Vona + Zova architecture, CLI-first workflows, bidirectional type synchronization, and AI Spec-Driven Development model. They differ primarily in their default UI layer, included demonstration suites, and out-of-the-box application baseline.

For fuller guidance on choosing an edition and working in an existing checkout, see Cabloy Editions.

Legend: ✅ Included in the default edition baseline · — Not included in the default edition baseline

Default UI Layer

Area Cabloy Basic Cabloy Start
UI library DaisyUI + Tailwind CSS Vuetify

Included Core Capabilities

Capability Description Cabloy Basic Cabloy Start
Master–detail forms Supports nested master–detail forms, including multiple levels of detail records.
Image uploads Supports local storage and Cloudflare storage backends.
File uploads Supports local storage and Cloudflare storage backends.
Payment integrations Demonstrates simulated payments, PayPal, and Stripe integrations.
Markdown editor Includes image uploads and syntax highlighting.

Included Demonstration Suites

Suite What it demonstrates Cabloy Basic Cabloy Start
Student Training Management Master–detail forms, nested detail records, image uploads, and file uploads. Cabloy Start additionally demonstrates data-scope-based RBAC.
E-commerce A complete Admin site, Web site, personal center, payment flows, Markdown editing, and related capabilities.
System Management User management, role management, department management, RBAC authorization, and menu authorization.

Included demonstration suites give AI vibe coding agents high-quality, project-native code examples. They improve development efficiency while reducing token use. For production deployments, set PROJECT_DISABLED_SUITES to a comma-separated list of unneeded suite names to disable them; see the Environment and Config Guide.

“Not included” means that the suite is not part of the default edition baseline. It does not limit what can be built with Cabloy.

Common commands

Purpose Command
Start Vona development npm run dev
Start one Vona development process npm run dev:one
Start Start Admin SSR development npm run dev:zova:admin
Start Start Web SSR development npm run dev:zova:web
Build all required artifacts npm run build
Build Start Admin SSR and REST artifacts npm run build:zova:admin
Build Start Web SSR and REST artifacts npm run build:zova:web
Type-check Vona and Zova npm run tsc
Check formatting npm run format
Lint npm run lint
Run backend tests npm run test
Run the full E2E suite npm run test:e2e
Run E2E tests without reset npm run test:e2e:fast

Upgrade the Cabloy framework baseline

Review framework updates before applying them:

npm run upgrade:dry-run
npm run upgrade

These commands synchronize framework-owned content from the public Cabloy package.

Support

License

Cabloy Start project-owned source, documentation, and assets are licensed under the MIT License, unless a file or directory includes its own complete license or third-party notice. See LICENSES.md for license scope and third-party terms.

About

Cabloy Start is a public, MIT-licensed business-system edition baseline for Cabloy, a coordinated Node.js fullstack system.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages