nuclio-component-library-2024
v1.0.1
Published
Component library for nuclio
Downloads
4
Readme
component-library-carlos
Component library for nuclio
Install
npm install nuclio-component-library-2024
Usage
import React, { Component } from 'react'
import MyComponent from 'nuclio-component-library-2024'
import 'nuclio-component-library-2024 /dist/index.css'
class Example extends Component {
render() {
return <MyComponent />
}
}
Mi Componente Library
Una biblioteca de componentes de React creada con Vite, configurada con Storybook y lista para ser publicada en npm.
Requisitos Previos
- Node.js (>=14.x)
- npm (>=6.x)
Configuración Inicial
Crear el Proyecto con Vite
Crea un nuevo proyecto de Vite:
npm create vite@latest mi-proyecto --template react cd mi-proyecto
Instala las dependencias necesarias:
npm install
Añadir y Configurar Storybook
Añade Storybook a tu proyecto:
npx sb init --builder vite
Crea tus componentes y sus historias en la carpeta
src/components
.Inicia Storybook:
npm run storybook
Publicar la Biblioteca en npm
Organiza la estructura del proyecto y exporta los componentes en
src/index.jsx
.Instala Rollup y las dependencias necesarias para la construcción:
npm install --save-dev rollup @rollup/plugin-node-resolve @rollup/plugin-commonjs @rollup/plugin-babel @rollup/plugin-terser rollup-plugin-peer-deps-external rollup-plugin-postcss
Crea el archivo de configuración de Rollup (
rollup.config.js
).Configura el archivo
package.json
para la publicación:{
"name": "nuclio-component-library-2024", "version": "1.0.0", "description": "Component library for nuclio ", "author": "carlosarenasf", "license": "MIT", "repository": "nds-fsd/component-library-2024", "scripts": { "dev": "vite", "build": "vite build", "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0", "preview": "vite preview", "storybook": "storybook dev -p 6006", "build-storybook": "storybook build", "build-library": "rollup -c" }, "dependencies": { "react": "^18.3.1", "react-dom": "^18.3.1" }, "devDependencies": { "@babel/core": "^7.15.0", "@babel/preset-env": "^7.15.0", "@babel/preset-react": "^7.14.5", "@rollup/plugin-babel": "^5.3.1", "@rollup/plugin-commonjs": "^21.1.0", "@rollup/plugin-node-resolve": "^13.3.0", "@rollup/plugin-terser": "^0.4.4", "@storybook/addon-essentials": "^7.6.17", "@storybook/addon-interactions": "^7.6.17", "@storybook/addon-links": "^7.6.17", "@storybook/addon-onboarding": "^1.0.11", "@storybook/blocks": "^7.6.17", "@storybook/react": "^7.6.17", "@storybook/react-vite": "^7.6.17", "@storybook/test": "^7.6.17", "@types/react": "^18.3.3", "@types/react-dom": "^18.3.0", "@vitejs/plugin-react": "^4.3.1", "eslint": "^8.57.0", "eslint-plugin-react": "^7.34.2", "eslint-plugin-react-hooks": "^4.6.2", "eslint-plugin-react-refresh": "^0.4.7", "eslint-plugin-storybook": "^0.8.0", "prop-types": "^15.8.1", "rollup": "^2.79.1", "rollup-plugin-peer-deps-external": "^2.2.4", "rollup-plugin-postcss": "^4.0.2", "rollup-plugin-terser": "^7.0.2", "storybook": "^7.6.17", "vite": "^5.3.1" } }
```
Compila la biblioteca:
npm run build
Inicia sesión en npm:
npm login
Publica tu paquete:
npm publish --access public
Resumen
Este archivo README.md
proporciona los pasos esenciales para configurar Storybook en un proyecto de Vite y publicar una biblioteca de componentes en npm. Para detalles específicos sobre el código de los componentes, consulta los archivos dentro del repositorio.
License
MIT © carlosarenasf