https://github.com/epilot-dev/custom-journey-block-react
A starter to build custom journey block web components with React
https://github.com/epilot-dev/custom-journey-block-react
Last synced: 8 months ago
JSON representation
A starter to build custom journey block web components with React
- Host: GitHub
- URL: https://github.com/epilot-dev/custom-journey-block-react
- Owner: epilot-dev
- Created: 2025-03-04T15:56:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-14T13:11:34.000Z (about 1 year ago)
- Last Synced: 2025-06-17T16:03:23.975Z (12 months ago)
- Language: TypeScript
- Size: 89.8 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Epilot Custom Journey Block Starter
## Overview
This is a starter project for creating custom journey blocks for the Epilot platform using React and web components.
## Prerequisites
- Node.js (v16+)
- npm or yarn
## Getting Started
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Development:
```bash
npm run dev
```
This would serve a build version of the app and would listen to changes in the files to refresh.
4. Build for production:
```bash
npm run build
```
## Project Structure
- `src/`: Source code directory
- `index.ts`: Entry point for the web component
- `vite.config.ts`: Build configuration
## Creating Your Journey Block
1. Modify the web component in `src/index.ts`
2. Add your custom logic and styling
3. Ensure the component follows Epilot's journey block specification
## Documentation
For detailed guidelines on creating custom journey blocks, refer to the [Epilot App Documentation](https://docs.epilot.io/apps/components/custom-journey-block).
## Deployment
The build process generates a `bundle.js` file that can be hosted and used in Epilot journeys.
## License
[MIT]