Skip to content
CaretCMS

Plug-in or starter

Both paths use the same @caretcms/core package. These are starting points, not different runtime modes or product editions.

Add editing to an existing site

Section titled “Add editing to an existing site”

Follow the Quickstart to add the integration and one editable field. Your components, routes, styles, and deployment remain yours.

To automate setup and template changes, run Caretize:

Terminal window
npx @caretcms/caretize@0.5.0 init
npx @caretcms/caretize@0.5.0 --review

Review the proposed bindings and test an edit before expanding to more pages. Choose static delivery for a site published as files, or server delivery for request-time content updates.

Run a working example

Section titled “Run a working example”

The public repository includes two useful starting points:

Example Use it to learn
examples/starter Explicit bindings, Studio, and Node server delivery; also contains test fixtures
examples/content-site Markdown collections, schemas, live data, and an editorial site

Clone the release and build its local packages before starting an example:

Terminal window
git clone --branch v0.5.0 https://github.com/web-stacked/caretcms.git
cd caretcms
npm install
npm run build:core
npm run build:zod
npm run build:caretize
npm run dev:starter

For the editorial example, stop the starter and run:

Terminal window
npm run dev:content

Use the local URL printed by Astro. Open /admin; if no editor password is configured, the development server prints a temporary one in the terminal. Both examples use server delivery, so ordinary field saves are live in that local example. Saving and publishing explains the exceptions for drafts and Markdown prose.

Turn an example into your own project

Section titled “Turn an example into your own project”

The examples are npm workspaces in the core repository. If you copy one into a standalone project, replace its workspace @caretcms/* dependencies (*) with the published version 0.5.0 and install dependencies in the new project. Keep the Astro adapter and any schema helper packages the example imports.

Remove test fixtures you do not need, then configure your content, credentials, storage, and host. Running an example locally does not configure production persistence or deployment for you. Follow Deployment before inviting editors.