Getting Started

Introduction

Claspo provides a starter repository for plugin development that includes:

Custom Components Development — initial project for developing your own components
Quickstart Demo — Docker container examples for deployment (editor, renderer, backend)

Before you begin, ensure you have the following installed:

Clone the starter template and install dependencies:

git clone https://github.com/Claspo/claspo-plugin-starter.git
cd claspo-plugin-starter
npm run install:all

Start all services with a single command from the repository root:

npm run dev

This runs components dev server, backend, and frontend concurrently.

Service	URL
Editor	http://localhost:4202/editor.html
Renderer	[http://localhost:4202/script.html](http://localhost:4202/script.html

Components are web components that extend WcElement. Each component lives in its own folder under components/:

components/
└── YourCustomComponent/
    ├── YourCustomComponent.js
    └── assets/

Command	Description
`npm run components:dev`	Start dev server with hot reload (port 9590)
`npm run components:build:prod`	Create production build in `bundled-components/`

For detailed component development guide, see README.md.

The quickstart/ folder provides Docker container examples for deploying Claspo plugin infrastructure:

For Docker deployment examples and detailed configuration, see quickstart/README.md.

cd quickstart
docker-compose up --build