rebul's Introduction

Rebul (Work In Progress 🚧)

React UI Component Library built with the Bulma CSS Framework

This library is currently under development, meaning the component API's will most likely change. Please have a look at the 1.0.0 Roadmap for detailed progress of the status of each component, and where you might like to help out.

Installation

npm install rebul bulma

Basic usage

Rebul does not depend on Bulma's stylesheets as we don't want to restrict you to any one version, hence you will have to import it yourself.

import Button from 'rebul/Button'; // or: import { Button } from 'rebul';
import 'bulma/css/bulma.css';

export default () => <Button color="primary">Hello world</Button>

Developing

You can easily develop Rebul components locally by running a local instance of our docs:

git clone https://github.com/jxom/rebul.git
cd rebul
npm install
npm run catalog-start

then navigate to http://localhost:4000

Contributing

Contributing to Rebul is easy! With four simple steps:

Create a branch

Fork the repository
git clone <your-repo-url> to clone your GitHub repo to your local one
git pull origin master to pull the latest code
npm install to install the project's dependencies
git checkout -b the-name-of-my-branch to create a branch (use something short and comprehensible, such as: added-button-component).

Make the change

Note: You can run npm run catalog-start, and then navigate to http://localhost:4000/ to interactively develop your changes.

Push the change!

git add -A && git commit -m "My message (#issue-number/pr-number)" (replacing My message (#issue-number/pr-number) with a commit message, such as Added button component (#43)) to stage and commit your changes
git push my-fork-name the-name-of-my-branch