@amperio/amperio-ui

A repository to house all design system components utilised inside of Amperio GUI

🌐 Links

• NPM: https://www.npmjs.com/package/@amperio/amperio-ui
• Storybook: https://nice-glacier-017894703.azurestaticapps.net

✨ Getting started

Prerequisites

You need to have installed the following software:

• nodejs (>=14.18.0 [LTS])
• yarn (>= 1.22.15)

Bootstrap

  git clone [e-mail]:amperio-com/amperio-ui
  cd amperio-ui
  cp .env.example .env
  yarn install

📜 Scripts:

Development

• create-hook - Generate a hook.
• create-function - Generate a function.
• create-component - Generate a component.

Build

• build - Build for production a ready application.
• build:local - Local build as npm package compressed to *.tgz

Release

• publish - Publish package to npm with sematic-release.

Shell

• reinstall-node-modules - Invokes rm -rf node_modules and yarn install.
• og - (open-github) Open github repository of the project.
• grlc - (git-reset-local-changes) Reset all of your local changes. BE CAREFUL!
• gcb - (git-create-branch) Create and checkout on the branch with the given name.
• gcdwp - (git-checkout-develop-with-pull) Checkout to develop branch and invokes pull command.
• gpc - (git-push-changes) Commit and push all files on a current branch with the given commit message.

Test

• test - Run tests.
• test:e2e - Run e2e tests.
• test:ci - Run tests in CI mode.
• test:watch - Run tests in watch mode.
• test:coverage - Run tests in coverage mode.
• test:update-snapshot: Run tests and update all snapshots.
• open:coverage: open result of coverage tests as a nice HTML page.

Analyze

• open:analyze - Analyze source maps explorer.
• lint - Run eslint. Output any errors 🚨.
• lint:fix - Run eslint with --fixflag . Fix any lint errors 🚨.
• typecheck - Run tsc. Output any errors 🚨.
• stylelint - Run stylelint. Output any errors 🚨.
• stylelint:fix - Run stylelint with --fixflag . Fix any lint errors 🚨.
• commitlint - Run commitlint on main branch. Output any errors 🚨.
• format - Run prettier with --write flag to format all the files.
• format:check - Run prettier with --check flag. Output any format errors 🚨.
• check-all - Run lint, test, typecheck, build, commitlint, stylelint and format:check. Output any errors 🚨.

📚 Documentation

Commit Message Guideline

• For easier commit type recognition commit messages are prefixed with a proper type
• See available commit types: https://www.npmjs.com/package/@commitlint/config-conventional# amperio-backoffice

Team

Paweł Wojtasiński	Łukasz Cybulski	Sebastian Kłosiński