diff --git a/packages/web2d/README.md b/packages/web2d/README.md index 7e34f895..4f0ba2fa 100644 --- a/packages/web2d/README.md +++ b/packages/web2d/README.md @@ -1,11 +1,43 @@ -# `web2d` +# `Web2D` -> TODO: description +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 -``` -const web2D = require('web2d'); +To start using web2d it has to be required as a module and then intanciarce as a function -// TODO: DEMONSTRATE API +``` +const Web2d = require('web2d'); +Web2d(); ``` diff --git a/packages/web2d/lib/web2d.js b/packages/web2d/lib/web2d.js index 9b2e3ae2..ee4b9c36 100644 --- a/packages/web2d/lib/web2d.js +++ b/packages/web2d/lib/web2d.js @@ -1,7 +1,9 @@ 'use strict'; function web2D() { - const coreJs = require('@wismapping/core-js'); //eslint-disable-line + global.$ = require('jquery'); + require('mootools'); + const coreJs = require('@wismapping/core-js'); //eslint-disable-line global.core = coreJs(); //eslint-disable-line const elementPeer = require('./components/peer/svg/ElementPeer').default; //eslint-disable-line diff --git a/packages/web2d/package.json b/packages/web2d/package.json index afb1fb9c..a76f996b 100644 --- a/packages/web2d/package.json +++ b/packages/web2d/package.json @@ -20,10 +20,9 @@ "url": "git+https://ezequielVega@bitbucket.org/lilabyus/wisemapping-frontend.git" }, "scripts": { - "start": "webpack serve --config webpack.dev.js", - "build": "yarn web2d:build && yarn test:build", - "web2d:build": "webpack --config webpack.prod.js", - "test:build": "webpack --config webpack.test.js" + "start": "nodemon --watch lib", + "build": "webpack --config webpack.prod.js", + "test": "webpack serve --config webpack.test.js" }, "devDependencies": { "@babel/core": "^7.14.6", @@ -33,14 +32,16 @@ "clean-webpack-plugin": "^4.0.0-alpha.0", "core-js": "^3.15.2", "html-webpack-plugin": "^5.3.2", + "nodemon": "^2.0.12", "webpack": "^5.44.0", "webpack-cli": "^4.7.2", "webpack-dev-server": "^3.11.2", "webpack-merge": "^5.8.0" }, "dependencies": { - "@wismapping/core-js": "^0.0.1", "@wisemapping/mindplot": "^0.0.1", + "@wismapping/core-js": "^0.0.1", + "jquery": "2.1.0", "mootools": "1.4.5" } } diff --git a/packages/web2d/test/javascript/render/arrow.html b/packages/web2d/test/javascript/render/arrow.html index 97932781..26020fa0 100644 --- a/packages/web2d/test/javascript/render/arrow.html +++ b/packages/web2d/test/javascript/render/arrow.html @@ -17,12 +17,7 @@ }; web2d.peer.utils = {}; - - - - - - + - - - - - + - - - - -