5rabbits / react-components

5rabbits react components repository

React components

This is a monorepo for individual 5rabbits react components.

Demo/Docs: https://5rabbits.github.io/react-components

Requirements

• NodeJS >= 6.9.0
• Yarn >= 1.0.0

Packages

The packages directory holds each individual package. Each package has (at least) the following commands:

# Build the package for production
$ yarn build

# Start the development server
$ yarn start

# Run the tests
$ yarn test

# Run the tests in watch mode
$ yarn test --watch

Global commands

The following commands are available at the root of this repository:

# Creates a new individual package
$ yarn create-package <name>

# Builds all the packages for production
$ yarn build

# Starts a storybook server for all packages
$ yarn start

# Tests all packages
$ yarn test

# Lints all packages
$ yarn lint

# Auto formats all packages code
$ yarn prettify

Lerna

This project uses lerna to manage and publish the individual packages.

Hooks

• All changes will be linted and prettified before commiting.
• Storybooks will be deployed automatically to github pages after publishing.

react-components's Issues

Storybooks deben partir con el readme

Sería más útil partir con el tab del readme pre-seleccionado.

Agregar badge de npm al readme de los paquetes

Ejemplo:

Adaptar readme de time-input al monorepo

Migramos el componente pero no adaptamos su readme, tiene links rotos y secciones que ya no aplican.

Publicar a gh-pages automáticamente después de un release

Actualmente tenemos un postpublish en el package.json de la raíz, pero no parece funcionar con lerna.

También podría configurarse en Travis para que publique cuando pase un commit a master.

Mejorar documentación para publicar

Explicar mejor como detectar cambios, incrementar versiones y finalmente publicar en npm.

Permitir acceder en prod a las historias de un componente en particular

Para poder linkear a la página pública desde cada componente individual.