Grommet: focus on the essential experience

Documentation

Visit the Grommet(link is external) 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(link is external) app tutorial for
new apps. For incorporating Grommet into an existing app, see the Existing App(link is external)
version.

Explore

1. Storybook(link is external) examples per component, you can create them locally by running:

     $ npm run storybook

   or

     $ yarn storybook

2. Basic code-sandbox playgrounds(link is external) for each component.

3. Templates, patterns, and starters(link is external): feel free to share with us
   more pattern ideas on Slack(link is external).

4. End-to-end project examples from our community in the
   #i-made-this Slack channel(link is external).

5. Read more from the Grommet team on Medium(link is external).

Stable

grommet is also available on a stable branch that is built with the content of the 'master' branch.
From your package.json point to stable.

"grommet": "https://github.com/grommet/grommet/tarball/stable",

For more info, read the stable wiki(link is external).

Release History

See the Change Log(link is external).

Tools Behind Grommet

Grommet is produced using this great tool:

• BrowserStack(link is external) for browser emulators and simulators.
• Circle CI(link is external) for continuous integration.