luma.gl/docs/get-started/installation.md

952 B

Installation

To use luma.gl in an application, use npm or yarn to install luma.gl

using yarn:

yarn add luma.gl

using npm:

npm install --save luma.gl

Testing using the Website

To build and make changes to luma.gl itself, go to the website directory and run yarn start or npm start to run the test server, it will open a web page from which you can access live examples and lessons. It automatically updates when you save modified source files.

Testing

Testing is performed on Travis CI and using a precommit hook. Local testing is supported on these environments:

  • npm test - runs tests under node using headless gl
  • npm run test-browser - Tests in your browser, may be helpful to quickly debug test case failures since it autoreloads on changes and gives you full access to your browser's debugger.

When adding new features, or modifying existing ones, carefully consider if unit testing can be provided.