1.0.2 ā¢ Published 3 years ago
mintflow-ui v1.0.2
mintflow React UI
The component library for fast and accessible development of gorgeous interfaces.
Projects using it: mintflow Dashboard React
Mission
Be the most accessible it can be out of the box and the fastest way to production.
Go to docs to see complete, live examples
š Usage
Install
npm i mintflow-ui
Inside tailwind.config.js
const mintflow = require('mintflow-ui/config')
module.exports = mintflow({
purge: [],
theme: {
extend: {},
},
variants: {},
plugins: [],
})
Then place mintflow
at the root of your project (the order doesn't matter, as long as your application is inside).
// index.js
import React from 'react'
import ReactDOM from 'react-dom'
import App from './App'
import { mintflow } from 'mintflow-ui'
ReactDOM.render(
<mintflow>
<App />
</mintflow>,
document.getElementById('root')
)
Use components inside your project
import { Button } from 'mintflow-ui'
function App() {
return <Button>Hi there!</Button>
}
export default App
š Contributing
- Fork
- Clone
npm install
npm run storybook
It will start a local server at localhost:6006
with all components rendered.
ā Use npm run cz
instead of git commit
! It will guide you through some short questions and guarantee that you commit message is standardized.
Commit will also trigger linting and test coverage.