https://github.com/kirandash/greenhouse-react-ui
🧩 React UI component library built with Tailwind CSS
https://github.com/kirandash/greenhouse-react-ui
component-library components contributions-welcome good-first-issue help-wanted open-source opensource react react-component-library reactjs tailwindcss
Last synced: about 1 year ago
JSON representation
🧩 React UI component library built with Tailwind CSS
- Host: GitHub
- URL: https://github.com/kirandash/greenhouse-react-ui
- Owner: kirandash
- License: mit
- Created: 2023-02-20T11:18:05.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-26T21:15:21.000Z (over 2 years ago)
- Last Synced: 2025-03-13T02:08:27.170Z (about 1 year ago)
- Topics: component-library, components, contributions-welcome, good-first-issue, help-wanted, open-source, opensource, react, react-component-library, reactjs, tailwindcss
- Language: TypeScript
- Homepage: https://6442bd489bd20422b7ada446-nmudwbaxnc.chromatic.com/
- Size: 979 KB
- Stars: 9
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Greenhouse React UI
The react component library with Tailwind and a gorgeous design system to help
you build awesome react projects.
## 🎯 Mission
Build a light weight accessible component library ready to be used out of the
box for building your next awesome react project.
## 🚀 Usage
Install
```sh
npm i greenhouse-react-ui
```
Inside `tailwind.config.js`
```js
const greenhouse = require('greenhouse-react-ui/config')
module.exports = greenhouse({
purge: [],
theme: {
extend: {},
},
variants: {},
plugins: [],
})
```
Then place `GreenHouse` at the root of your project (the order doesn't matter,
as long as your application is inside).
```js
// index.js
import React from 'react'
import ReactDOM from 'react-dom'
import App from './App'
import { GreenHouse } from 'greenhouse-react-ui'
ReactDOM.render(
,
document.getElementById('root'),
)
```
Use components inside your project
```js
import { Button } from 'greenhouse-react-ui'
function App() {
return Hi there!
}
export default App
```
## 🔌 Contributing
- Fork
- Clone
- `npm install`
- `npm run storybook`
It will start a local server at `localhost:6006` with all components rendered.
`git commit` to commit your changes
`git push` will trigger prettier format check, linting, audit and build.
## 🙏 Support
Please ⭐️ star this project and share it with others to show your support. [Follow me](https://github.com/kirandash) ❤️ for updates on future projects and tutorials!