https://github.com/eclass/ui-kit

Elementos gráficos transversales para proyectos eClass
https://github.com/eclass/ui-kit

hacktoberfest react storybook typescript

Last synced: about 2 months ago
JSON representation

Elementos gráficos transversales para proyectos eClass

• Host: GitHub
• URL: https://github.com/eclass/ui-kit
• Owner: eclass
• Created: 2021-09-02T19:15:24.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T14:12:51.000Z (3 months ago)
• Last Synced: 2024-10-29T15:55:47.245Z (3 months ago)
• Topics: hacktoberfest, react, storybook, typescript
• Language: TypeScript
• Homepage: http://ui-kit.eclass.com/
• Size: 36.2 MB
• Stars: 4
• Watchers: 6
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
[[_TOC_]]

## Información

Este repositorio es una librería de componentes que se pensó para unificar estilos en los desarrollos de Eclass

La fuente de donde se basan los componentes se encuentran en este [**Sistema de diseño**](https://zeroheight.com/15698077d/p/48fae4-eclass-sistema-de-diseo)

## Scripts

Los componentes están al 100% en escritas en archivos `typescript`.

Además deben ser testeadas en donde el enfoque del `testing` es asegurarse de que se muestre todo lo que se promete

Por otra parte cada componente debe llevar su `storie` donde muestre todos los estados que puede tomar el componente

```

  npm run dev

```

Para trabajar de manera local

```

  npm run storybook

```

Levanta el entorno de `storybook`

```

  npm run test

```

Ejecuta los test con `jest`

## Instalación

Se debe instalar este repositorio más unas dependencias

### npm

```shell

npm install @eclass/ui-kit @chakra-ui/react @emotion/react @emotion/styled framer-motion

```

### Implementación

Ejemplo de implementación en código.

```js

import { ChakraProvider } from '@chakra-ui/react'

import { theme } from '@eclass/ui-kit'

const AppWrapper = () => (

  

    

  

)

```