elyra/canvas

Overview

The Common Canvas tooling consists of two Node JS modules:

1. A Common Canvas for use in building canvas-like applications. See detailed API and event documentation.

2. Test harness
   See here for setting up local environment

Using local version of common-canvas and/or common-properties

Clone elyra/canvas

git clone git@github.com:elyra-ai/canvas.git
# install global libraries for building
npm install -g grunt-cli sass
# Build common-canvas and common-properties
./<elyra/canvas>/canvas_modules/common-canvas/build.sh

In your application's package.json replace

"@elyra/canvas": "<version>"

with

"@elyra/canvas": "file:<elyra/canvas>/canvas_modules/common-canvas"

Delete @elyra/canvas from node_modules of your application

# Run npm install to get local copy of common-canvas and/or common-properties
npm install

Contribute to the Elyra Canvas documentation (mkdocs)

1. Python v3 needs to be available.

2. Go to canvas directory.

3. Install required mkdocs packages using pip3.

pip3 install -r requirements.txt`

4. Run below command to start mkdocs server.

mkdocs serve

5. When complete, open the browser: http://127.0.0.1:8000/