Vegas JS - version 1.0.12 is an Opensource Framework based on ECMAScript for develop crossplatform Rich Internet Applications and Games.
|core||The core package is specialized in functions utilities that are highly reusable without creating any dependencies : arrays, strings, chars, objects, numbers, maths, date, colors, etc.|
|system||The system package is the root for the VEGAS JS framework. It is the starting point of our RIA framework structure : signals, W3C events, datas and collections (ADT), IoC container (Dependency Injection), logger, tasks, transitions, logics, rules, models, etc.|
|graphics||The graphics library is an intuitive graphics API to manipulate all display objects in your applications. Offers a lot of powerful functionality to create and work with graphics, colors and geometrics objects, all neatly wrapped up in a well designed, consistent and clean programming interface.|
Under tree opensource licenses :
Download on Bitbucket the latest code, report an issue, ask a question or contribute :
Get started with the the Vegas JS API :
These tutorials helps you to understand the VEGAS JS Framework philosophy.
Send us your email to join the VEGAS community on Slack !
$ yarn add vegas-js --dev
$ npm install vegas-js --save-dev
VEGAS JS use Yarn with a serie of powerful packages (Babel, Mocha, etc.) to compile and build this library.
1 - The first time, initialize the project and run yarn :
2 - Test + compile all the libraries :
$ yarn build
1 - Build the ./dist/vegas.js : not minified + no comments + sourcemap.
$ yarn dev
2 - Build the ./dist/vegas.js and watch the changing into the ./src folder.
$ yarn watch
3 - Build the ./dist/vegas.min.js : minified + no comments.
$ yarn prod
4 - Build the ./dist/vegas.min.js and the ./dist/vegas.js libraries only.
$ yarn vegas
1 - Build the ./dist/vegas.molecule.js : not minified + no comments + sourcemap.
$ yarn molecule-dev
2 - Build the ./dist/vegas.molecule.js and watch the changing into the ./src folder.
$ yarn molecule-watch
3 - Build the ./dist/vegas.molecule.min.js : vegas + molecule + minified + no comments.
$ yarn molecule-prod
4 - Build all the vegas+molecule libraries only.
$ yarn molecule
Note : See all the examples of the molecule library in the examples/ folder of the project.
To launch the VEGAS HTML examples, use the command :
$ yarn example ./examples/molecule/pixi/basic.html
This command launch with the BrowserSync tool the html page of the example in your browser.
We use the Mocha and the Chai (http://chaijs.com/) tools to run the unit tests of the VEGAS JS libraries.
1 - Run all unit tests
$ yarn test
2 - Run a specific library, use one of this command :
$ yarn test-core $ yarn test-system $ yarn test-graphics $ yarn test-molecule
The --match option trigger the unit test engine (based on Mocha) to only run tests matching the given pattern which is internally compiled to a RegExp, for examples :
$ yarn test -g graphics
Run all the graphics package unit tests.
$ yarn test -g graphics.CardinalDirection $ yarn test -g core.arrays.contains
Run only the graphics.CardinalDimension unit tests or the core.arrays.contains module unit tests.
The --reporter option define the unit test result rendering in the terminal with the values : 'spec', 'dot', 'landing', 'dot', 'nyan', 'list', 'mochawesome'. By default the 'spec' value is used.
$ yarn test --reporter nyan
The documentation of the framework is based on JSDoc.
Run the documentation build with gulp :
$ yarn doc
The documentation is generated in the folder : ./docs/bin