Una poderosa librería de React diseñada para simplificar y mejorar el desarrollo de aplicaciones web modernas. Ofreciendo una amplia gama de componentes, esta librería te ayuda a acelerar tu proceso de desarrollo y crear interfaces de usuario atractivas y funcionales de manera eficiente.
Antes de comenzar, asegúrate de tener instalado Node.js y npm en tu sistema. Puedes descargarlos desde sitio web de Node.js.
Si aún no tienes un proyecto de React, sigue las instrucciones en el enlace de React https://react.dev/learn/start-a-new-react-project, o abre tu terminal y ejecuta el siguiente comando:
npx create-next-app mi-aplicacion-react
Esto creará un nuevo directorio llamado "mi-aplicacion-react" con la estructura básica de un proyecto React.
Dirígete al directorio de tu proyecto:
cd mi-aplicacion-react
Ahora, utiliza npm para instalar @ogticrd/ui-kit
npm install @ogticrd/ui-kit
Con el fin de disponer de la configuración de los temas y los estilos pertinentes dentro del proyecto, se debe agregar la configuracion del ThemeProvider en el archivo raiz. Ej:_app.ts
, app.js
, layout.js
, etc.
import { ThemeProvider } from '@ogticrd/ui-kit'
...
<ThemeProvider>
<body>
{children}
</body>
</ThemeProvider>
...
Abre el archivo donde deseas utilizar la librería. Importa la librería al principio del archivo:
import Button from '@ogticrd/ui-kit/Button';
Luego, puedes utilizar los componentes o funciones proporcionadas por la librería en tu aplicación:
import Button from '@ogticrd/ui-kit/Button';
function MiComponente() {
return (
<div>
<Button onClick={() => console.log('Genial!')}>
Clickeame
</Button>
{/* Otro código de tu aplicación */}
</div>
);
}
export default MiComponente;
Guarda tus cambios y ejecuta la aplicación:
npm run dev
Visita http://localhost:3000
en tu navegador para ver tu aplicación en ejecución.
¡Listo! Has completado la instalación de @ogticrd/ui-kit
en tu proyecto de React. Ahora puedes comenzar a explorar y aprovechar las características que ofrece la librería en tu aplicación.
La visualización de componentes está disponible con storybook.
Utilizando pnpm
:
git clone https://github.com/opticrd/sdd-kit.git
cd sdd-kit
pnpm install
pnpm storybook
Chromatic nos permite detectar y corregir problemas visuales en nuestra librería, lo que garantiza una experiencia de usuario consistente y de alta calidad.
inicia sesión en Chromatic utilizando las credenciales proporcionadas.
Una vez que hayas iniciado sesión, busca el proyecto deseado en la lista de proyectos creados en Chromatic.
Dentro del proyecto seleccionado, encontrarás una lista de builds creados a partir de diferentes ramas del repositorio. Cada build representa una versión del proyecto en un estado específico.
Selecciona el build deseado para ver los componentes disponibles en esa versión. Dentro de cada build, encontrarás una lista de componentes con la opción de verlos en Storybook.
Haz clic en el botón correspondiente para acceder a Storybook y explorar los componentes en el contexto del build seleccionado.
Si necesitas más detalles sobre cómo desplegar tu proyecto te recomendamos visitar la documentación de Storybook para obtener instrucciones detalladas sobre cómo hacerlo.
- Lenguaje: TypeScript
- Framework: React
- UI Framework: MUI
- Gustavo Valverde - Product Manager - @gustavovalverde
- Kevin Jimenez - Technical Lead - @akevinieron
- Christian de la Cruz - Developer - @ChristianDC13
- José Álvarez - Developer - @JE1999
- Tomás Familia - Developer - @Tomas-Alexander
Información de diseño: https://uxkit.digital.gob.do/