Skip to content

Commit ad3e157

Browse files
committed
document local setup. closes #3
1 parent 5ea5b1e commit ad3e157

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,26 @@ Open a [pull request](https://github.com/splitbrain/pinoutleaf/pulls) or [ticket
9494
```
9595
5. The tool will generate corresponding `.svg` files (e.g., `config.front.svg`, `config.back.svg`) in the same directory as the input files.
9696

97+
### Local Setup
98+
99+
If you want to run the web editor locally, you have two options:
100+
101+
1. **Using Node.js:**
102+
- Clone the repository.
103+
- Install dependencies:
104+
```bash
105+
npm install
106+
```
107+
- Start a local server:
108+
```bash
109+
npm run serve
110+
```
111+
- Open your browser and navigate to `http://localhost:8080`.
112+
2. **Use your own web server and prebuilt sources:**
113+
- Copy the [gh-pages](https://github.com/splitbrain/pinoutleaf/tree/gh-pages) branch to your web server document root.
114+
115+
Please note that for both cases, because of CORS, images will not be embedded into the SVG files, an error will be logged to the console, and the images will be linked instead. This is not a problem when using the CLI tool or using the online editor.
116+
97117
## Configuration Syntax
98118

99119
Diagrams are configured using YAML or JSON files. Most things have sensible defaults.

0 commit comments

Comments
 (0)