Updating READMEs with basic self-hosting instructions (#75)

usewaypoint · Apr 10, 2024 · 1fa51d4 · 1fa51d4
1 parent 391c5c4
commit 1fa51d4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git 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
@@ -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.
-Original file line number
+Diff line change
@@ Expand Up / @@ -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.
     ---
@@ Expand Down @@