Prerequisites
Before running the editor locally or installing the package, make sure your environment meets these requirements.
For local development (monorepo)
| Requirement | Version |
|---|---|
| Node.js | 22 or later |
| pnpm | 11.17.0 (recommended; see packageManager in the repo) |
The monorepo uses pnpm workspaces and Turborepo for builds and tests.
node -v # should print v22.x or higher
pnpm -v # should print 9.x or higher
If you do not have pnpm installed:
corepack enable
corepack prepare pnpm@11.17.0 --activate
For using the package in your app
| Requirement | Notes |
|---|---|
| Node.js | 22+ when using a bundler or SSR |
| Modern browser | Any browser with ES module support |
| Bundler (recommended) | Vite, webpack, Rollup, or similar |
The package ships as ESM and CJS with TypeScript declarations. Import the bundled stylesheet alongside the JavaScript entry point:
import '@toastwrite/editor/style.css';
Optional tooling
These are used in the editor repository but are not required to consume @toastwrite/editor:
- TypeScript 5 — for type checking in the monorepo
- Vitest — for running tests
- ESLint 9 — for linting
Clone the repository
To run or contribute to the editor source:
git clone https://github.com/toastwrite/editor.git
cd editor
pnpm install
Continue with Run locally to start the demo application.