Skip to content

Shellishack/pulse-editor

Repository files navigation

About

Pulse Editor is an editor designed to build and work with AI more naturally on cross-platform devices.

Getting Started -- User Guide

Web Client

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

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).

Desktop Client

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

Only Windows is tested in alpha release.

VSCode Extension

A VSCode Webview Extension with limited features is available here.

Getting Started -- Development Guide

Web Development

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

npm run 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.
npx cap run android -l --host [your_LAN_server_that_your_phone_can_access]
# Production
npm run android

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 out-desktop.

VSCode Extension Development

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.

About

An AI powered code editor to boost your productivity.

Resources

License

Stars

Watchers

Forks

Packages

No packages published