@paulossjunior/storybook-example
v0.0.3
Published
Este guia mostra como criar, buildar e publicar manualmente uma biblioteca de componentes que usa o [Storybook](https://storybook.js.org/) para documentação visual e o [npm](https://www.npmjs.com/) como registro público de pacotes.
Readme
📦 Publicando uma Biblioteca com Storybook Manualmente no npm
Este guia mostra como criar, buildar e publicar manualmente uma biblioteca de componentes que usa o Storybook para documentação visual e o npm como registro público de pacotes.
✅ Pré-requisitos
- Conta no npm
- Node.js e npm instalados (
node -venpm -v) - Projeto com:
package.json- Pasta
src/com os componentes - Storybook configurado (
.storybook/) - Um script
buildfuncional para gerar a lib (ex:dist/)
📁 Estrutura esperada
meu-design-system/
├── .storybook/
├── dist/
├── src/
├── package.json
├── vite.config.ts
└── README.md🛠️ Passo a Passo
1. 📦 Configure o package.json
{
"name": "meu-design-system",
"version": "1.0.0",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": ["dist"],
"scripts": {
"build": "vite build",
"storybook": "storybook dev -p 6006",
"storybook:build": "storybook build -o storybook-static"
},
"keywords": ["componentes", "storybook", "design-system"],
"author": "Seu Nome",
"license": "MIT"
}⚠️ Escolha um nome de pacote único, que ainda não esteja publicado no npmjs.com.
2. 🛠️ Build da biblioteca
Gere os arquivos da lib:
npm run buildIsso deve gerar a pasta
dist/com os arquivos de saída.
3. 🧪 Teste local do Storybook
Você pode rodar o Storybook localmente:
npm run storybookOu gerar os arquivos para deploy:
npm run storybook:buildIsso gera a pasta
storybook-static/, que pode ser usada para publicar no GitHub Pages, Netlify, etc.
4. 🔐 Faça login no npm
npm loginSiga as instruções e informe seu usuário, senha e e-mail.
5. 🚀 Publique no npm
npm publish --access publicUse
--access publicna primeira publicação, especialmente se for um pacote com escopo (ex:@seunome/pacote).
O Exemplo publicado: https://www.npmjs.com/package/@paulossjunior/storybook-example
✅ Atualizações futuras
- Mude a versão com:
npm version patch # ou minor / major- Rode novamente:
npm run build
npm publish🌐 Publicar o Storybook (opcional)
Para publicar o Storybook visualmente (em GitHub Pages, Netlify, etc.):
npm run storybook:buildDepois hospede o conteúdo da pasta storybook-static.
