Skip to content

Trabajo presentado en la charla 16 de Pro In Chile sobre styleguidist y storybook en React.

Notifications You must be signed in to change notification settings

hmontes/docs-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Descripción

Este archivo es una demostración simple de React Styleguidist y Storybook para entender su uso mínimo. Incluye componentes propios.

Code Example

Puedes ver la documentación de ejemplo en http://hmontes.github.io/docs-example/

Motivación

Un día estaba trabajando en un proyecto particular y necesitaba agregar una función en el Header de una pagina web. El problema fue que tenía un desorden y no recordaba cual propiedad se encargaba de gestionar al usuario online y me armé un lio para buscar lo que había hecho (Y un gran dolor de cabeza). Desde allí decidí ordenar el codigo desde el principio y documentar lo que hacía.

También sirve para poder trabajar en equipos de trabajo e incluso para aplicar test más facilmente.

Instalación

  • Clonar el repositorio
  • cd docs-example
  • npm install
  • Usar: npm run styleguide o npm run storybook

Referencia

Puedes ver los archivos de configuración en /styleguide.config.js o en /.storybook

Tests

No hay test implementados por el tamaño pequeño del ejemplo.

Contribución

Un pequeño agradecimiento a la gente de Pro in Chile por la oportunidad de presentar y a la gente del grupo React Chile.

Licencia

Dado a que hay componentes especiales, no sería malo que hicieras una pequeña referencia a mi persona si usas algo de este pequeño proyecto.

About

Trabajo presentado en la charla 16 de Pro In Chile sobre styleguidist y storybook en React.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published