Skip to content

ClayPulse/pulse-editor

Repository files navigation

Pulse Editor

Important

Pulse Editor is still in its early development stage. We are trying hard to make sure everything works as expected for all different platforms. See Beta Release Roadmap below.

Pulse Editor

Discord Licence

Table of Contents

Introduction

Pulse Editor is a cross-platform tool built to make AI-powered creation and development feel intuitive and seamless.

Beta Release Roadmap

🎉🎉Pulse Editor is now in beta.

We plan to have 2-3 major beta release stages before we reach a stable release version.

Major Beta Release 1 (June 2025):

Pulse Editor is now available on Android and Desktop (tested for Windows, needs more testing for Linux and MacOS).

Pulse Editor Marketplace now is available for editor users. Simply download Pulse Editor, and view all available extensions in the extension page. You can also browser and search extensions in Marketplace Web (WIP). As for now, the following extensions are available:

Pulse Editor Marketplace Developer Access is now open for application. If you'd like to develop and publish your own extensions to Pulse Editor Marketplace, submit a form here Developer Beta Access.

Even if you haven't got access to publish your extensions to the marketplace, you can still explore Pulse Editor platform by developing your own extensions locally. This is a great opportunity to get an early look at Pulse Editor and start experimenting with its capabilities! See Extension Development below.

Major Beta Release 2 (planned for 2025 Q3)

Planned items:

  • Documentation
  • Support for web
  • Support remote Pulse Editor instance access
  • Extension app AI builder
  • ... (WIP)

Coming Soon: Making 100 Extension Apps Challenge

Major Beta Release 3 (planned for 2025 Q4)

... (WIP)

Documentation (WIP)

The documentation will be available at https://docs.pulse-editor.com. You can find documentation repository here.

Getting Started -- User Guide

Web Client

There is a web deployment at https://editor.claypulse.ai

For detailed web user guide, check out Web User Guide

Mobile Client

Android client is available in release page.

Current we only support Android, although it is technically possible to have an iOS build (see developer guide below).

For detailed mobile user guide, check out Mobile User Guide

Desktop Client

Linux, MacOS, Windows clients are available in release page.

Note

Only Windows is tested in alpha release.

For detailed desktop user guide, check out Desktop User Guide

VSCode Extension

A VSCode Webview Extension with limited features is available here.

For detailed VSCode extension user guide, check out VSCode Extension User Guide

Getting Started -- Development Guide

Recommended Nodejs version

Nodejs 20

Install dependencies

You can install dependencies for all workspaces using

npm i

Or, for a specific workspace. e.g. for web:

npm i --workspace=web

Install dependencies (desktop native modules)

When dependencies in desktop/, use Electron's nodejs instead of local nodejs.

Make sure you have installed necessary build tools.

For Windows

Nodejs Windows Installer should already include windows-build-tools. In addition, make sure Windows SDK is also available:

For Linux

sudo apt install -y make python build-essential

Then you can rebuild native dependencies in desktop/ using.

# For Windows
./node_modules/.bin/electron-rebuild.ps1 -m desktop -v (electron_version)
# For Linux
./node_modules/.bin/electron-rebuild -m desktop -v (electron_version)

For example, Electron may warn you need NODE_MODULE_VERSION xxx. If you have electron@35.0.2 installed (check desktop/package.json), you can run:

./node_modules/.bin/electron-rebuild -m desktop -v 35.0.2

Web Development

Pulse Editor uses Next.js as the frontend (and backend -- TBD). You can get started with local development by running:

npm run web-dev

Mobile Development

Pulse Editor uses Capacitor.js to create mobile apps on Android and iOS. To develop mobile app locally, run the following:

# Development with Live Reload. You need to first run a local development server as specified above.
cd mobile
npx cap run android -l --host [your_LAN_server_that_your_phone_can_access]
# Production
npm run android-build

Desktop Development

Pulse Editor uses Electron.js to create desktop apps on Windows, Mac and Linux. To develop desktop app locally, run:

# Development
npm run desktop-dev
# Production
npm run desktop-build

If you run npm run desktop-build for a production build, you can find an executable file inside build/desktop.

VSCode Extension Development

Warning

The code in vscode-extension might be out of date, as it was made for an Alpha Demo.
Support for using Pulse Editor as an extension in VSCode might be discontinued, or get simply replaced with a webview.

Pulse Editor uses VSCode Webview API to create a VSCode Extension. To develop VScode Extension locally, open the vscode-extension in a separate VSCode window. Then press F5 to launch debug task.

Note that you will also need to run the Nextjs server locally during development.

Pulse Editor Extension Development

Pulse Editor uses Modular Federation to deliver its modular extensions. For guides on how to start developing and using extensions locally, check out our React template repository.

Some of our official extensions are also open-source. Feel free to take examples from them and/or contribute to them.

About

Your AI-powered creative companion. A modular, cross-platform editor built to adapt to your ideas, no matter how you create.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •