@ingaia/ingaia-ui

This repository is a package of components created with React keeping the Gaia style guide.

Docs:

inGaia React Components

Install

yarn add @ingaia/ingaia-ui

Usage

import React, { Component } from 'react';

import { Button } from '@ingaia/ingaia-ui';

class Example extends Component {
  render() {
    return <Button text="Save" />;
  }
}

Contributing

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

• Clone the project:

  $ git clone https://github.com/ingaia/react.npm.git

• Install dependencies:

  $ yarn install

• Create components:

  • Create your component
  • Create a documentation for your component: *.mdx
  • Starter guide: Docz

• View components:

  $ yarn start

• Change the version:

  $ package.json "version": "x.x.x"

• Build the project:

  $ yarn build

• Publishing NPM

  $ npm publish

• Publishing Doc

  $ yarn deploy

• Create a new branch for this commit and start a pull request

Prerequisites

Node.js
Docz
Yarn or NPM

Built With

React
Styled-Components
Docz

Authors

Conrado Ramalho
Daniel Henrique
Jefferson Santos
Ricardo Teixeira

See also the list of contributors who participated in this project.