https://github.com/zooniverse/zoo-grommet
https://github.com/zooniverse/zoo-grommet
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zooniverse/zoo-grommet
- Owner: zooniverse
- Created: 2017-05-31T19:30:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T02:38:09.000Z (about 2 years ago)
- Last Synced: 2024-04-23T06:27:34.089Z (about 2 years ago)
- Language: SCSS
- Size: 632 KB
- Stars: 3
- Watchers: 11
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Zoo Grommet
A Zooniverse theme from the [Grommet](https://grommet.github.io/) React component library.
## How to use
Install the package:
```
npm install --save zoo-grommet
```
And include the CSS file in your project:
```
@import "~zoo-grommet/dist/zoo-grommet.css"
```
Note for webpack users: make sure you have your css-loaders configured and add to the css-loader options:
```
options: {
includePaths: [path.resolve(__dirname, 'node_modules/zoo-grommet/dist')]
}
```
Grommet components are imported from the library as normal, e.g.
```
import Box from 'grommet/components/Box';
```
### Publishing to NPM
Run [`npm version`](https://docs.npmjs.com/cli/version) and push to GitHub including tags.