Skip to content
Alan Souza edited this page Nov 24, 2015 · 19 revisions

To build Grommet in your local environment, execute the following commands:

  1. Install Ruby. (version 1.9.3+ required)

  2. Install the Ruby scss-lint package:

```
$ gem install scss_lint
```
  1. Clone Grommet repo:
```
$ git clone https://github.com/HewlettPackard/grommet.git
```
  1. Install NPM packages and Gulp:
```
$ cd grommet
$ npm install
$ npm install -g gulp
```
  1. Create the NPM distribution:
```
$ gulp dist
```

This step will create the **dist** folder with content ready to be deployed in NPM.
  1. Create the Bower distribution:
```
$ gulp dist-bower
```

This step will create the **dist-bower** folder with content ready to be used or deployed in Bower. 

Running Grommet Tests

Tests are located in the test folder. You can execute them by running the following command:

$ gulp test

This step will also create the code coverage report under coverage/lcov-report/index.html.

Contributing

The Grommet team is looking forward to your contributions. If you are interested in contributing while getting comfortable with the platform, consider adding to the unit test library. We believe a good way to learn a new framework is by writing tests for it.

Clone this wiki locally