🧱 Design System

Modular and expanded library of components created using Vite, Storybook and Typescript. Suitable for re-used UI elements in various projects

📚 Installation of the library

• pnpm

pnpm add @sem.antony/design-system

• yarn

yarn add @sem.antony/design-system

• npm

npm i @sem.antony/design-system

📚 Usage

| Script | Command | Description | |----------------------------|----------------------|----------------------------------------------------------| | START AND DEVELOPMENT | | | | Start | nps start | 🚀 Start Vite dev server | | Storybook Dev | nps dev | 📘 Launch Storybook on port 6006 | | Preview | nps preview | 👀 Preview the built project | | Build Storybook | nps buildStorybook | 📘 Build Storybook | | FORMATTING AND LINTING | | | | Format | nps format | 🎨 Format the project using Prettier | | Lint | nps lint | 🔍 Lint the project | | LintFix | nps lintFix | 🧹 Lint with auto-fix | | TESTING | | | | Test | nps test | 🧪 Run tests using Vitest not implemented yet! | | BUILD AND PREPARATION | | | | Prebuild | nps prebuild | 🧨 Clean the dist folder before build | | Generate Index | nps generateIndex | 📄 Generate a shared index file for components | | Build | nps build | 📦 Full project build: index, Vite, and TypeScript | | VERSIONING PROCESS | | | | Preversion | nps preversion | ⚙️ Tasks to run before bumping the version | | COMMITS AND CHANGES | | | | Add Changeset | nps addChangeset | 📦 Add a changeset with a manual description | | Git Commit | nps gitCommit | 📮 Use an interface for creating a git commit | | VERSIONS AND RELEASES | | | | Version Patch | nps version.patch | 🔖 Bump the patch version | | Version Minor | nps version.minor | 🆙 Bump the minor version | | Version Major | nps version.major | 🚀 Bump the major version | | Version Beta | nps version.beta | 🧪 Release a beta version | | Version Alpha | nps version.alpha | 🧬 Release an alpha version | | Version RC | nps version.rc | 🧪 Release a release candidate version |

📚 Usage commands

• To run the project in development mode

nps start

• To run storybook

nps dev

• To preview the built project

nps preview

• To build the project

nps build

• To build storybook

nps buildStorybook

• To format the project

nps format

• To lint the project

nps lint

• To lint the project with auto-fix

nps lintFix

• To run tests(not implemented yet)

nps test

• To clean the dist folder

nps prebuild

• To generate a shared index file

nps generateIndex

• To run tasks before bumping the version

nps preversion

• To add a changeset

nps addChangeset

• To use an interface for creating a git commit

nps gitCommit

• To bump the patch version

nps version.patch

• To bump the minor version

nps version.minor

• To bump the major version

nps version.major

• To release a beta version

nps version.beta

• To release an alpha version

nps version.alpha

• To release a release candidate

nps version.rc

🛠 Support and Questions

If you have any questions or suggestions for improvements, please open an issue on GitHub

You can find the full source code of the library here