graine-ui v0.1.1

Graine UI

WIP React component library made with TailwindCSS.

Getting Started

Install Graine UI

$ yarn add graine-ui

or

$ npm install graine-ui

Wrap your app with ThemeProvider

import React from 'react';
import { ThemeProvider } from 'graine-ui';

const App = () => (
  <ThemeProvider>
      {/* Your app here */}
  </ThemeProvider>
);

And... you're good to go!

Usage

import { Button } from 'graine-ui';

const App = () => (
  <ThemeProvider>
    <Button>Hello World</Button>
  </ThemeProvider>
);

Documentation is currently wip, so use types as a reference for now.

Editing source code

Graine UI's source code is hosted on Github. If you want to change something, you can make a PR or open an issue.

Setting up your local environment

First, you need to clone the repository.

$ git clone https://github.com/otomir23/graine-ui.git

Then, you need to install dependencies.

$ yarn install
$ cd example && yarn install

After that, you can start developing.

Local development

Because Graine UI uses TSDX, starting the build hot reload is as simple as running

$ yarn start

To preview the changes, you can run development server.

$ cd example && yarn start

When you are done, you can build the components for production and run tests.

$ yarn build
$ yarn test

Additional resources

Learn more about TSDX here

Learn more about TailwindCSS here.

License

Graine UI is licensed under the MIT License.