mandrigin/localwardleymaps

fork of OnlineWardleyMaps that is an electron app monitoring a local file

★ 5Forks 0TypeScriptGitHub ↗Compare

Project website ↗

README

OnlineWardleyMaps

Mentioned in Awesome Wardley Maps

The source code that runs www.OnlineWardleyMaps.com.

Also available as a standalone Visual Studio Extension - vscode-wardley-maps.

Developed by @damonsk.

Wardley Mapping courtesy of Simon Wardley, CC BY-SA 4.0. To learn more, see Simon's book.

Running locally

Dependencies for running locally: Node.js and Yarn.

npm install yarn -g

Change directory to frontend.

cd frontend/

Install dependencies

yarn install

Web Browser

To run locally in browser, open http://localhost:3000

yarn dev

To create minified scripts/styling.

yarn build

To run all tests.

yarn test

Desktop App (Electron)

Run as a desktop application with native file system access:

yarn electron:dev

Open a specific file on launch:

yarn electron:dev -- /path/to/your-map.owm

Build distributable packages (outputs to dist/):

yarn electron:build

Build unpacked for testing:

yarn electron:pack

After building, you can also pass a file path directly to the app:

./dist/mac/OnlineWardleyMaps.app/Contents/MacOS/OnlineWardleyMaps /path/to/map.owm

VS Code / Obsidian Packages

To create package for use in vscode-wardley-maps or obsidian-wardley-maps.

yarn package

Alternatively, you can also run it locally using the provided Dockerfile.

From the root repository, build a container image via

`docker build -t onlinewardleymaps .`

and then run it locally

`docker run -p 3000:3000 onlinewardleymaps`

Now you can access the frontend @ http://localhost:3000

Support the Project

If you find obsidian-wardley-maps, OnlineWardleyMaps or vscode-wardley-maps valuable, consider supporting its development:

Patreon

Follow on X (Twitter) @MapsAsCode for updates and announcements!

Your support helps maintain and improve this plugin as well as OnlineWardleyMaps and vscode-wardley-maps. Every contribution is appreciated. Thank you for your support!

Contributors

damonskmandrigindependabot[bot]ShaunBulbrookmruegChristianDavisjawnCircleviewtmotyldemeringomichaelekins

Issues