Grommet: focus on the essential experience
Documentation
Visit the Grommet v2 website for more information.
Support / Contributing
Before opening an issue or pull request, please read the Contributing guide.
Install
You can install Grommet using either of the methods given below.
For npm users:
$ npm install grommet styled-components --save
For Yarn users:
$ yarn add grommet styled-components
There are more detailed instructions in the Grommet Starter app tutorial for
new apps. For incorporating Grommet into an existing app, see the Existing App
version.
Explore
-
Storybook examples per component, you can create them locally by running:
$ npm run storybookor
$ yarn storybook -
Basic code-sandbox playgrounds for each component.
-
Templates, patterns, and starters: feel free to share with us
more pattern ideas on Slack. -
End-to-end project examples from our community in the
#i-made-this Slack channel. -
Read more from the Grommet team on Medium.
Release History
See the Change Log.
Tools Behind Grommet
Grommet is produced using this great tool:
- BrowserStack for browser emulators and simulators.
- Circle CI for continuous integration.