ds-ui-lib documentation

ds-ui-lib

Egy könnyű Angular UI komponenskönyvtár a DS Systems-től.
Élő dokumentáció: Storybook (komponenspéldák) és Compodoc (API), közzétéve GitLab Pages-en.
A kiadásokat automatizált CI/CD, valamint semantic-release kezeli.

📚 Tartalomjegyzék

✨ Áttekintés

  • ♻️ Újrahasznosítható, moduláris Angular komponensek
  • 📘 Storybook integráció: élő, kattintható példák
  • 🧾 Compodoc: generált API dokumentáció
  • 🚦 GitLab CI/CD: lint → test → build → docs → pages
  • 🏷️ semantic-release: automatikus verzió és changelog
  • 🌐 GitLab Pages: Storybook / Docs / Demo publikálás

📦 Telepítés

Example :
npm install @ds-systems/ds-ui-lib

Ha privát registry-t használsz, ellenőrizd az npm beállításokat (auth token, registry).

🚀 Gyors használat

Importálj modulokat az alkalmazásodba, majd használd a komponenseket.

Example :
import { DsButtonModule } from '@ds-systems/ds-ui-lib';

@NgModule({
  imports: [DsButtonModule],
})
export class YourModule {}

További példák: lásd a Storybookot.

🌐 Élő dokumentáció

🛠️ Fejlesztési folyamat

Branch stratégia

  • Kiindulás: master
  • Feature: feat/<rövid-leírás>
  • Fix: fix/<rövid-leírás>
Example :
git checkout master
git checkout -b feat/button-icon-support

Commit üzenetek

Használd a Conventional Commits mintát.

Példa:

Example :
git commit -m "feat(button): ikon támogatás hozzáadása"

Elterjedt prefixek: feat, fix, docs, chore, refactor, test, ci, build.

🔢 Szemantikus verziókezelés

A verziók és a CHANGELOG a commitokból generálódnak.

  • feat: → minor növekedés
  • fix: → patch növekedés
  • BREAKING CHANGE: → major (1.0.0+)

CI/CD röviden

  • master push: release futtatás és tárhely-tisztítás
  • tag: install → lint → test → build → docs → storybook → pages
    • publish-npm: kézzel indítható a tagelt pipeline-ban

Artefaktumok: Storybook, Compodoc, Demo, CHANGELOG → GitLab Pages.

🧰 Hasznos parancsok

Parancs Leírás
npm run lint:all Lintelés futtatása
npm run test:ds-ui UI library tesztjei
npm run test:ds-ui-lib Demo app tesztjei
npm run docs:html Compodoc HTML generálás
npm run build-storybook Storybook statikus build
npx semantic-release Kiadás (helyi környezetben csak tesztelésre)

🐞 Hibakeresés

  • Nem frissül a verzió / changelog: ellenőrizd, hogy a commit üzenetek Conventional Commits szerintiek-e.
  • Pages nem frissül: nézd meg a pages job logját, és hogy a szükséges artefaktumok létrejöttek-e (storybook-static, compodoc, dist).
  • NPM publikálás sikertelen: ellenőrizd a NPM_TOKEN-t és a dist/ds-ui/package.json meglétét.

🧾 Licenc

© DS Systems – 2025. Minden jog fenntartva.

results matching ""

    No results matching ""