wisemapping-frontend/packages/web2d/README.md

# `Web2D`

Web2d create the custom charts for the **Wisemapping** ecosystem.

## 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_

2. Move to folder web2d

```
cd packages/web2d
```

3. Now you need install all dependence, this is done with command `yarn install`

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

## Production

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

## Testing

For the testings of web2d you need use command `yarn test` 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 web2d it has to be required as a module and then intanciarce as a function

```
const Web2d = require('web2d');
Web2d();
```