femiral-components-lib

Ett minimalt komponentbibliotek byggt med Vite + React och Storybook 9.

Syfte:
Ge en snabb och isolerad miljö för att utveckla, dokumentera och testa UI-komponenter. Vite används för en enkel demoapp, medan Storybook används för komponentutveckling och dokumentation.

Versioner

• Node: >=22.19.0
• npm: >=10.9.3
• React: ^19.1.1

Installera nvm, node och npm

NVM

• Linux/Mac installation

  • curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
  • export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
  • [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # Laddar in nvm utan att starta om terminalen

• Windows installation

  • Klicka på 'Download Now!' i nvm-windows repots Readme
  • Installera .exe filen tillhörande den senaste releasen
  • Följ installations programmet

Kontrollera installation genom att köra nvm -v i terminalen

Installera node och npm

• Kör nvm install för projektets exakta version eller nvm install 22 för senaste versionen inom samma major-release
  • Kommandot installerar också npm samtidigt
  • Kommandot byter även till den installerade node- och npm versionen

Kom igång

Ta hem repot

• Navigera dit du vill klona projektet
• Klona repot: git clone https://github.com/Frommflin/fwk-femiral-components.git
• Navigera in i repomappen: cd fwk-femiral-components
• Kör: nvm use eller nvm use 22 #beroende på vald installation

Installera dependencies

npm install

Kör app

npm run dev

Kör storybook

npm run storybook

CI workflow

Projektet genomgår test av bygge (npm run build) vid varje push in i master-branchen. Resultat av bygget hittas under Actions > Node.js CI i repo-menyn, alternativ navigera direkt till https://github.com/Frommflin/fwk-femiral-components/actions/workflows/react-build.yml