Please begin by reading our contributing guidelines. The contributing document will provide you with all the information you need to get started. Later, as part of your first pull request, you will be asked to sign our Contributors License Agreement. More information on the process is included in the full contributor's guide.
Ready to get started? The below sections take you through the steps required to get the framework running on your local development environment, and run the associated tests.
To build the code, follow these steps.
- Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
- From the project folder, execute the following command:
npm install- Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp- To build the code, you can now run:
gulp build-
You will find the compiled code in the
distfolder, available in several different module formats. -
See
gulpfile.jsfor other available tasks.
To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
- Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli- Ensure that jspm is installed. If you need to install it, use the following command:
npm install -g jspm- Install the client-side dependencies with jspm:
jspm install- You can now run the tests with this command:
karma start