From 1fa51d4f33d0415580e1d48d3705acbf0b602149 Mon Sep 17 00:00:00 2001 From: Jordan Isip Date: Wed, 10 Apr 2024 16:15:28 -0400 Subject: [PATCH] Updating READMEs with basic self-hosting instructions (#75) --- README.md | 2 +- packages/editor-sample/README.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d586f3f..8bf27a4 100644 --- a/README.md +++ b/README.md @@ -204,7 +204,7 @@ await axios({ ## Self hosting the Editor -A self-hosted version of the editor is coming soon. In the mean time you can use the packages/sample-editor as an example. +You can fork this repository and use [packages/editor-sample](https://github.com/usewaypoint/email-builder-js/tree/main/packages/editor-sample) as an example. View the README file to see how to run it locally. --- diff --git a/packages/editor-sample/README.md b/packages/editor-sample/README.md index 37255c7..a9ad8b0 100644 --- a/packages/editor-sample/README.md +++ b/packages/editor-sample/README.md @@ -1 +1,10 @@ # @usewaypoint/editor-sample + +Use this as a sample to self-host EmailBuilder.js. + +To run this locally, fork the repository and then in this directory run: + +- `npm install` +- `npx vite` + +Once the server is running, open http://localhost:5173/email-builder-js/ in your browser.