@salthq/admin-component-lib

Salt HQ admin component library

Stack

A library of admin components written with Vite, Vue3, Storybook, TypeScript and TailwindCSS

Install

Run: npm i @salthq/admin-component-lib

Local component usage

You can include any of the components locally by adding:

<script setup lang="ts">
import { SltAdminButton } from "@salthq/admin-component-lib";
</script>

<template>
    <slt-admin-button />
</template>

Package management

Installation

• Clone repository to your local machine
• Install dependecies: npm install

Run Storybook for HMR development

• npm run storybook

Run tests

• npm run test

// TODO Re-write all the tests to use Vitest expect instead of external 'chai' assert https://vitest.dev/api/#expect

Update changelog

• Add new version and changes to changelog.md

Build prod distribution

• npm run build

Publish to npm

• Make sure version in package.json is updated (incremented up)
• Commit changes and push to main
• Create a release git tag -a 1.0.1 -m "Release version 1.0.1" && git push origin 1.0.1
• npm run build
• Log in to NPM first by running npm login and inserting your credentials
• Publish package npm publish --access=public