Home

Awesome

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

The project depends on AWS Amplify and an AWS account as it creates supporting infrastructure (for saving maps and serving accounts).

The infrastructure that will be created is defined here: https://github.com/damonsk/onlinewardleymaps/tree/master/frontend/amplify/backend

The costs will be minimal as it's based on serverless offerings and likely covered under the Free Tier if you have a new account. For reference, it's approximately $1 a month for the current live site.

The documentation for getting started with the amplify cli can be found @ https://docs.amplify.aws/javascript/start/getting-started/installation/

Dependencies for running locally: Node.js, Yarn, and Amplify.

npm install yarn -g
npm install -g @aws-amplify/cli

Change directory to frontend.

cd frontend/

Install dependencies

yarn install

Initialise Amplify environment

amplify init

Commands:

To run locally, develop/edit. Open web browser @ http://localhost:3000

 yarn dev

To create minified scripts/styling.

yarn build

To run all tests.

yarn test

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

yarn package