wisemapping-frontend/packages/mindplot/README.md
Paulo Gustavo Veiga d1ac9fc9a6 Fix typo
2021-10-02 11:23:24 -07:00

1.1 KiB

Mindplot

The Mindplot is manager all Wisemapping. In it is implemented the packages of core-js and web2d.

Quick Start

  1. Clone repository with the next command:
git clone https://[username]@bitbucket.org/wisemapping/wisemapping-frontend.git

where the variable username is you username of Bitbucket.

Note:The project is configured to use the yarn dependency manager

  1. Move to folder mindplot
cd packages/mindplot
  1. Now you need install all dependence, this is done with command yarn install

  2. To start the development enviroment you have to use command yarn start.

Production

To build up the package mindplot and use in production, you have to use command yarn build

Playground

For the testings of mindplot you need use command yarn playground for run this enviroment. once this is done, it will open the explorer where you can see a menu with the tests carried out.

Usage

To start using mindplot it has to be required as a module and then intanciarce as a function

const mindplot = require('@wisemapping/mindplot');
mindplot();