Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
allow:
- dependency-type: "direct"
versioning-strategy: increase
18 changes: 18 additions & 0 deletions .pulse-editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# About Pulse App
This is a Pulse App template. A Pulse App is a module federated app that can run standalone or be integrated as an extension to Pulse Editor platform.

Pulse Editor is a modular, cross-platform, AI-powered productivity platform with federated app collaboration and extensible workflows. Pulse Editor itself does not serve any key features except providing a place for Pulse Apps to be hosted and interacted. Pulse apps are loaded to Pulse Editor via Module Federation.

# About Pulse App React template
You are now using the official React template for Pulse Apps. It consists both frontend and backend codes.

## Frontend code
The frontend uses React, and frontend code is located under `src/`, except in `src/assets` (public folder) and `src/server-function` (backend folder). This template is not much different from a standard React app, except that there is a pre-made entry at `src/main.tsx`. It does not yet support multi-page app, so there is only one entry point.

In addition, the template comes with `@pulse-editor/react-api` pre-installed -- a npm package to interact with Pulse Editor platform in case of:
- read editor context
- interact with other Pulse Apps

## Backend code
The backend uses Node.js, and backend code is located under `src/server-function`. If the frontend needs to call backend API endpoint, it can use fetch to do so. For example, to call an echo endpoint, use `fetch("/server-function/echo")`.

9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
## Pulse Editor Extension Template
This is a React template which you can use to make your own Pulse Editor extension. It uses Webpack Module Federation to share extensions with Pulse Editor.
## Pulse App Template

This is a React full-stack template which you can use to make your own Pulse Editor app. It uses Webpack Module Federation to share modules with Pulse Editor, which enables full-stack apps collaboration in a canvas workflow (see [Pulse Editor](https://github.com/claypulse/pulse-editor)).

For more information about Pulse Editor core and its ecosystem, visit our [Pulse Editor GitHub](https://github.com/claypulse/pulse-editor) and [documentation](https://docs.pulse-editor.com).

## Get Started

### Create Pulse Editor extension app using CLI

Expand Down
3 changes: 3 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
declare module '*.css';
declare module '*.scss';
declare module '*.sass';
Loading