levannta-ui 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -64
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Levannta UI
|
|
2
2
|
|
|
3
|
-
Una biblioteca de componentes UI moderna construida con React y CSS.
|
|
3
|
+
Una biblioteca de componentes UI moderna construida con React y CSS por Levannta.
|
|
4
4
|
|
|
5
5
|
## Instalación
|
|
6
6
|
|
|
@@ -17,31 +17,6 @@ yarn add levannta-ui
|
|
|
17
17
|
pnpm add levannta-ui
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
### Desde GitHub
|
|
21
|
-
|
|
22
|
-
Para instalar la biblioteca directamente desde GitHub, agrega lo siguiente a tu `package.json`:
|
|
23
|
-
|
|
24
|
-
```json
|
|
25
|
-
"dependencies": {
|
|
26
|
-
"levannta-ui": "github:levannta/levannta-ui#main"
|
|
27
|
-
}
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
O usando la línea de comandos:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
# Si estás usando npm
|
|
34
|
-
npm install github:levannta/levannta-ui#main
|
|
35
|
-
|
|
36
|
-
# Si estás usando yarn
|
|
37
|
-
yarn add github:levannta/levannta-ui#main
|
|
38
|
-
|
|
39
|
-
# Si estás usando pnpm
|
|
40
|
-
pnpm add github:levannta/levannta-ui#main
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Puedes también especificar una versión o commit específico cambiando `#main` por `#tag`, `#semver:x.x.x` o el hash de un commit.
|
|
44
|
-
|
|
45
20
|
## Uso
|
|
46
21
|
|
|
47
22
|
### Importación de componentes
|
|
@@ -117,44 +92,7 @@ El componente Button tiene los siguientes tamaños:
|
|
|
117
92
|
</Button>
|
|
118
93
|
```
|
|
119
94
|
|
|
120
|
-
### Uso local (durante desarrollo)
|
|
121
|
-
|
|
122
|
-
Para usar la biblioteca localmente en otro proyecto:
|
|
123
|
-
|
|
124
|
-
```bash
|
|
125
|
-
# En el directorio de levannta-ui
|
|
126
|
-
npm run build
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
Luego, en tu otro proyecto:
|
|
130
|
-
|
|
131
|
-
```json
|
|
132
|
-
// package.json del otro proyecto
|
|
133
|
-
{
|
|
134
|
-
"dependencies": {
|
|
135
|
-
"levannta-ui": "file:../path/to/levannta-ui"
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
Ejecuta `npm install` y luego importa los componentes como se muestra arriba.
|
|
141
|
-
|
|
142
|
-
## Documentación con Storybook
|
|
143
|
-
|
|
144
|
-
Puedes ver todos los componentes y sus variantes en nuestro Storybook, disponible en Google Cloud Run. El despliegue se realiza automáticamente a través de GitHub Actions.
|
|
145
|
-
|
|
146
|
-
### URLs de Storybook
|
|
147
|
-
|
|
148
|
-
- **Producción**: [https://storybook-levannta-ui-XXXXX.run.app](https://storybook-levannta-ui-XXXXX.run.app) (automáticamente desplegado desde la rama `main`)
|
|
149
|
-
- **Previews de PRs**: Cada Pull Request recibe un URL único para probar los cambios (disponible en los comentarios del PR)
|
|
150
|
-
|
|
151
|
-
### Configuración del despliegue
|
|
152
|
-
|
|
153
|
-
Los archivos de configuración para el despliegue de Storybook se encuentran en:
|
|
154
|
-
- `.docker/storybook/` - Configuración de Docker y nginx
|
|
155
|
-
- `.github/workflows/` - Workflows de GitHub Actions
|
|
156
95
|
|
|
157
|
-
Consulta `.docker/storybook/README.md` para más detalles sobre la configuración y requisitos.
|
|
158
96
|
|
|
159
97
|
## Desarrollo
|
|
160
98
|
|
|
@@ -178,4 +116,4 @@ npm run build
|
|
|
178
116
|
|
|
179
117
|
## Licencia
|
|
180
118
|
|
|
181
|
-
MIT
|
|
119
|
+
MIT# levannta-ui by Levannta ❤️
|