|
1 | 1 | # webgme-plotly |
2 | | -## Installation |
3 | | -First, install the webgme-plotly following: |
4 | | -- [NodeJS](https://nodejs.org/en/) (LTS recommended) |
5 | | -- [MongoDB](https://www.mongodb.com/) |
| 2 | +This repository contains components for visualizing [plotly](https://plotly.com/javascript/) JSON in [webgme |
| 3 | +](https://github.com/webgme/webgme). |
| 4 | +## Quick start |
| 5 | +Use [webgme-cli](https://github.com/webgme/webgme-cli) to import `PlotlyGraph` panel to your webgme app: |
6 | 6 |
|
7 | | -Second, start mongodb locally by running the `mongod` executable in your mongodb installation (you may need to create a `data` directory or set `--dbpath`). |
| 7 | +```sh |
| 8 | +$ webgme import viz PlotlyGraph webgme-plotly |
| 9 | +``` |
8 | 10 |
|
9 | | -Then, run `webgme start` from the project root to start . Finally, navigate to `http://localhost:8888` to start using webgme-plotly-viz! |
| 11 | +After import, `PlotlyGraph` will be available as a visualizer in your project. An example can be found |
| 12 | + in [deepforge](https://github.com/deepforge-dev/deepforge). |
10 | 13 |
|
11 | | -## Plotly Visualizer For webgme |
12 | | -This repository contains implementations for visualizing [plotly](https://plotly.com/javascript/) JSON in webgme. |
| 14 | +## Examples |
| 15 | +This repository is a functioning example of the `PlotlyGraph`. First, make sure you have an instance of mongo |
| 16 | + running locally. Then, simply clone this repository and run it. |
13 | 17 |
|
14 | | -### Usage |
15 | | -Checkout the following [seed](./src/seeds/testProject.webgmex), load it as a project and select `PlotlyGraph` panel |
16 | | - for the sampleGraph node as shown in the figure below |
| 18 | +```sh |
| 19 | +git clone https://github.com/deepforge-dev/webgme-plotly.git |
| 20 | +cd webgme-plotly |
| 21 | +npm install |
| 22 | +npm start |
| 23 | +``` |
| 24 | +Then, navigate to `http://localhost:8888`, select the following [seed](./src/seeds/testProject.webgmex), load it as a |
| 25 | + project and select `PlotlyGraph` panel for the sampleGraph node as shown in the figure below: |
17 | 26 |
|
18 | 27 |  |
19 | 28 |
|
20 | | -### Customization |
| 29 | +## Customization |
21 | 30 | To use it in your own visualizer to visualize plotly JSON from your project nodes, use the following customization |
22 | 31 | panel parameters. |
23 | 32 | ``` |
|
0 commit comments