Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gsoft-inc/ov-igloo-ui
Officevibe design system
https://github.com/gsoft-inc/ov-igloo-ui
components design-system nextjs react storybook
Last synced: 1 day ago
JSON representation
Officevibe design system
- Host: GitHub
- URL: https://github.com/gsoft-inc/ov-igloo-ui
- Owner: gsoft-inc
- License: apache-2.0
- Created: 2021-07-30T14:29:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T18:44:21.000Z (about 1 month ago)
- Last Synced: 2025-01-10T13:18:36.722Z (12 days ago)
- Topics: components, design-system, nextjs, react, storybook
- Language: TypeScript
- Homepage: https://igloo.officevibe.design
- Size: 7.36 MB
- Stars: 20
- Watchers: 4
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Igloo
Igloo gives a collection of React components for building their products
Report a Issue . Ask a Question
## Documentation
Visit [igloo.officevibe.design](https://igloo.officevibe.design) to learn more.
## Usage
To use a component from this repo you will first need to install the component into your project.
For an example we will try to use the `@igloo-ui/card` component.
```bash
npm i @igloo-ui/card
# or with yarn
yarn add @igloo-ui/card
```
Then to use the component in your code just import it!
```js
import Card from '@igloo-ui/card';
```
## Getting Started
Before starting make sure [node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/) is installed
### Install
After cloning ov-igloo-ui, run `yarn` to install dependencies.
```bash
git clone https://github.com/gsoft-inc/ov-igloo-ui.git
cd ov-igloo-ui
yarn
yarn storybook
```
### Scripts
- `yarn storybook`: run Storybook
- `yarn test`: run tests
- `yarn lint`: check if the JS, TS correspond on standard
- `yarn lint:style`: check if the style correspond on standard
## 🤝 Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.If you're interested, definitely check out our Contributing Guide!
## License
Copyright © 2019, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.