Skip to content

Commit fbf3fbf

Browse files
docs: update getting started section for custom journey blocks with epilot CLI
1 parent 55b09de commit fbf3fbf

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/apps/components/custom-journey-block.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,17 @@ Custom Journey Blocks are web components that follow standard web technologies,
3434
- Familiarity with Web Components standards
3535
- A development environment with Node.js
3636

37-
### Starter Template
37+
### Getting Started
3838

39-
We recommend starting with our React starter template to quickly set up your development environment:
39+
The fastest way to scaffold a journey block is with the **epilot CLI**:
4040

41-
```bash title="Clone and run the React starter template"
42-
# Clone the starter template
43-
git clone https://github.com/epilot-dev/custom-journey-block-react.git my-custom-block
41+
```bash title="Scaffold a journey block with the CLI"
42+
# Initialize a new app (if you don't have one yet)
43+
npx epilot app init my-app
44+
cd my-app
4445

45-
# Navigate to the project directory
46-
cd my-custom-block
46+
# Add a custom journey block component
47+
npx epilot app add-component my-block --type CUSTOM_JOURNEY_BLOCK
4748

4849
# Install dependencies
4950
npm install
@@ -52,7 +53,9 @@ npm install
5253
npm run dev
5354
```
5455

55-
You can also use our template for [Lit](https://github.com/epilot-dev/custom-journey-block-lit) to create a new project.
56+
This creates a ready-to-use component with all the boilerplate wired up, including the web component wrapper and manifest configuration.
57+
58+
You can also find starter templates for each framework in the [app-templates](https://github.com/epilot-dev/app-templates) repository.
5659

5760
### Technology Recommendations
5861

0 commit comments

Comments
 (0)