0.1.0 โข Published 7 months ago
@sem.antony/design-system v0.1.0
๐งฑ 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
distfolder
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
1.0.3
7 months ago
1.0.3-beta.2
7 months ago
1.0.3-beta.1
7 months ago
1.0.3-beta.0
7 months ago
1.0.2
7 months ago
1.0.1-rc.0
7 months ago
1.0.1-alpha.0
7 months ago
1.0.1-beta.0
7 months ago
1.0.0
7 months ago
0.1.0
7 months ago
0.0.13
7 months ago
0.0.12
7 months ago
0.0.12-beta.0
7 months ago
0.0.11
7 months ago
0.0.10
7 months ago
0.0.9
7 months ago
0.0.8
7 months ago
0.0.6
7 months ago
0.0.5
7 months ago
0.0.4-beta.1
7 months ago
0.0.4-beta.0
7 months ago
0.0.2
7 months ago
0.0.1
7 months ago