Giter Club home page Giter Club logo

bui-react's Introduction

Build Status Scrutinizer Code Quality bitHound Dependencies bitHound Overall Score bitHound Dependencies bitHound Code codecov

BUI React

The React component Library

Installation

To install, simply type the command at your terminal:

$ npm install --save bui-react

Thats all!

Example Usage

import Button from 'bui-react/Button';

export default (props) => {
    return (
        <div>
            <span>Hello there! <Button type="secondary">Click me</Button>
        </div>
    )
}

Visit the official documentation for more examples: Documentation

bui-react's People

Contributors

iamao avatar

bui-react's Issues

Setup and add testing environment with continuous integrations.

Bug/Feature Request?

Both I think

Description

There are no tests! Panic!
Setup environment for automated testing and continuous integration.

Tech:
  • Try out Jest(fallback to mocha)
CI
  • TravisCI (fallback to circleCI)
  • Scrutinizer( fallback to CodeClimate) :)

if bug, steps to reproduce

There are no tests! Panic!

Redesign UI for documentation site

Bug/Feature request

Feature

Description

As it stands, the user interface for the documentation site looks really ugly.
And it is not pleasing to look at. A fix for this is urgently required.

Steps to reproduce(bug)

N/A

Remove unnecessary files

Bug/Feature Request

There are unneccessary files that need to be removes

Description

Currently some files that are not required exists in github and its absolutely required to remove them.

If bug, steps to reproduce

N/A

Enhance README documentation

Bug/Feature Request

Enhance and add more content to README

Description

The readme is empty. README is what makes it possible to communicate information about this library to potential users or contributors

If bug, steps to reproduce

Add a "Getting Started" page to the documentation app

Bug/Feature Request

Add a page for a "Getting Started" guide

Description

The initial load page will be the getting started page.
This page will tell give user the following guides:

  1. How to Install
  2. How to use
  3. How to contribute
Dev Notes

First, try writing the guide to an markdown file and parse it to display in a react component.

If bug, steps to reproduce

N/A

Implement a custom routing framework

Bug/Feature Request

A routing framework that'll grow with the tool

Description

Currently the routing framework used is not as robust as would allow scaling. A custom routing framework that can handle routes and route params well is needed.
Note: Only If worst comes to worst, try the implementation that React Router uses.
Intercepting routes is already implemented so all that is left is mappin routes to components.

If bug, steps to reproduce

N/A

Implement basic theming engine

Bug/Feature Request

Add an engine for theming the components

Description

Add engine for theming components. Instead of having just a set of default style, the component will pull style from a theme. A theme file will be either a YAML, JSON or JS file. In future implementations, user will be able to add their own themes and load it.

If bug, steps to reproduce

N/A

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.