Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating READMEs with basic self-hosting instructions #75

Merged
merged 1 commit into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff 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
9 changes: 9 additions & 0 deletions packages/editor-sample/README.md
Original file line number Diff line number Diff line change
@@ -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.
Loading