0.0.6 โ€ข Published 7 months ago

@sem.antony/design-system v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

๐Ÿงฑ 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

ScriptCommandDescription
START AND DEVELOPMENT
Startnps start๐Ÿš€ Start Vite dev server
Storybook Devnps dev๐Ÿ“˜ Launch Storybook on port 6006
Previewnps preview๐Ÿ‘€ Preview the built project
Build Storybooknps buildStorybook๐Ÿ“˜ Build Storybook
FORMATTING AND LINTING
Formatnps format๐ŸŽจ Format the project using Prettier
Lintnps lint๐Ÿ” Lint the project
LintFixnps lintFix๐Ÿงน Lint with auto-fix
TESTING
Testnps test๐Ÿงช Run tests using Vitest not implemented yet!
BUILD AND PREPARATION
Prebuildnps prebuild๐Ÿงจ Clean the dist folder before build
Generate Indexnps generateIndex๐Ÿ“„ Generate a shared index file for components
Buildnps build๐Ÿ“ฆ Full project build: index, Vite, and TypeScript
VERSIONING PROCESS
Preversionnps preversionโš™๏ธ Tasks to run before bumping the version
COMMITS AND CHANGES
Add Changesetnps addChangeset๐Ÿ“ฆ Add a changeset with a manual description
Git Commitnps gitCommit๐Ÿ“ฎ Use an interface for creating a git commit
VERSIONS AND RELEASES
Version Patchnps version.patch๐Ÿ”– Bump the patch version
Version Minornps version.minor๐Ÿ†™ Bump the minor version
Version Majornps version.major๐Ÿš€ Bump the major version
Version Betanps version.beta๐Ÿงช Release a beta version
Version Alphanps version.alpha๐Ÿงฌ Release an alpha version
Version RCnps 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

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