Dev Kit Italia

Dev Kit Italia è un toolkit
che implementa il Design system .italia

italia.github.io/dev-kit-italia

⚠️ Attenzione: questo repository e i relativi pacchetti sono in lavorazione. Attualmente sono pubblicati per permetterne lo sviluppo, non sono consigliati per l'utilizzo in ambienti di produzione.

Intro

Dev Kit Italia è un set di Web components che implementa il Design system .italia e i componenti presenti su UI Kit Italia. Per navigare la libreria e visualizzare i componenti, è stato utilizzato Storybook. La documentazione è disponibile qui per l'ultima release stabile pubblicata.

Come usare la libreria

Per utilizzare Dev Kit Italia come dipendenza in un'app è possibile installarla da npm.

Come contribuire 💙

Per installare la libreria e avviare Storybook in locale, è necessario avere installato Node.js e pnpm.

Per installare le dipendenze:

pnpm install

Per compilare tutti i componenti (necessario la prima volta):

pnpm build

Per avviare Storybook in locale:

pnpm storybook

Durante lo sviluppo:

• Documentazione/Storie e tipi: si aggiornano automaticamente ✨
• Componenti: puoi ricompilare il solo package modificato

# Per esempio, se stai modificando il componente button:
pnpm build --filter=@italia/button
# Poi ricarica la pagina del browser

Nota: È necessario eseguire pnpm build prima di avviare Storybook la prima volta per compilare i pacchetti TypeScript in JavaScript.

Esempi di integrazione dei Web Components in altri framework JavaScript

Sono disponibili delle applicazioni di esempio che mostrano come integrare i Web Components in diversi framework JavaScript.

Per maggiori dettagli, consulta il file examples/README.md.

Processo di Rilascio 🚀

Il progetto utilizza Changesets per gestire i rilasci di tutti i pacchetti. Per informazioni dettagliate, consulta la documentazione di rilascio.

Il workflow GitHub Actions pubblicherà automaticamente tutti i pacchetti su NPM.