Skip to content

Commit e23aa4d

Browse files
feat(docs): creación del readme (#491)
1 parent 5e7d85f commit e23aa4d

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
[[_TOC_]]
2+
3+
## Información
4+
5+
Este repositorio es una librería de componentes que se pensó para unificar estilos en los desarrollos de Eclass
6+
7+
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)
8+
9+
## Scripts
10+
11+
Los componentes están al 100% en escritas en archivos `typescript`.
12+
13+
Además deben ser testeadas en donde el enfoque del `testing` es asegurarse de que se muestre todo lo que se promete
14+
15+
Por otra parte cada componente debe llevar su `storie` donde muestre todos los estados que puede tomar el componente
16+
17+
```
18+
npm run dev
19+
```
20+
21+
Para trabajar de manera local
22+
23+
```
24+
npm run storybook
25+
```
26+
Levanta el entorno de `storybook`
27+
28+
```
29+
npm run test
30+
```
31+
32+
Ejecuta los test con `jest`
33+
34+
## Instalación
35+
36+
Se debe instalar este repositorio más unas dependencias
37+
38+
### npm
39+
40+
```shell
41+
npm install @eclass/ui-kit @chakra-ui/react @emotion/react @emotion/styled framer-motion
42+
```
43+
44+
### Implementación
45+
46+
Ejemplo de implementación en código.
47+
48+
```js
49+
import { ChakraProvider } from '@chakra-ui/react'
50+
import { theme } from '@eclass/ui-kit'
51+
52+
const AppWrapper = () => (
53+
<ChakraProvider theme={theme} resetCSS={false}>
54+
<App />
55+
</ChakraProvider>
56+
)
57+
```

0 commit comments

Comments
 (0)