Fullstack Quickstart
This guide explains the fastest way to start a Cabloy fullstack project.
1. Prerequisites
Before creating a new Cabloy project, make sure your environment has:
| Name | Version |
|---|---|
pnpm | >=10.19.0 |
Node.js | >=24.4.0 |
Redis | >=7.2.6 |
SQLite3 | Built-in |
MySQL | >=8 |
PostgreSQL | >=16 |
Redis: powers queue, schedule, startup, broadcast, caching, two-layer cache, and redlockSQLite3: if you usebetter-sqlite3, set upnode-gypbefore installing dependencies
2. Create a new project
npm create cabloyThe generated project already includes CLAUDE.md and the .claude/ workspace assets. This path creates a Cabloy Basic project baseline. Open this project in Claude Code and start coding immediately with project-specific guidance.
3. Start the backend
npm run dev4. Start the frontend for your edition
Cabloy Basic
npm run dev:zova:admin # http://localhost:9000/admin/
npm run dev:zova:web # http://localhost:9000/Cabloy Start
Cabloy Start is the private commercial edition. Instead of npm create cabloy, purchase access to the licensed private repository, clone that source directly, and run npm run init. Then use the frontend commands provided by that edition. Do not assume the Cabloy Basic flavor names apply to Cabloy Start.
For the full Start onboarding details, including the access and initialization flow, read Cabloy Start.
If you are not sure which edition you are using or which one to choose, read:
5. Upgrade an existing project
npm run upgrade6. Next steps for framework-aware development
If you are contributing to framework-aware workflows or using Cabloy CLI generation directly, prefer CLI-backed generation over manual scaffolding.
Instead of creating framework files by hand, start with:
npm run vona :create
npm run zova :createThen narrow into the specific command family you need.
7. Shared verification commands for deeper workflow checks
If you are validating framework-aware changes or a broader workflow, use the shared project scripts before declaring a workflow correct:
npm run tsc
npm run test
npm run buildChoose more targeted checks when only one area is affected, but treat these scripts as the shared reference surface.