@autosync/atx-activix-ui

Activix UI

Activix UI is a library of UI components for all Activix's products.

Getting Started

Usage documentation in progress...

• Tailwind configuration
• Component usage
• Default CSS
• Vue plugins (modal & notify)
• Icons usage

Installation

• Add the provided Tailwind preset in your tailwind.config.js:

  presets: [
      require('@activix/ui/configs/tailwind-preset.js'),
  ],
  

• Add the following to the content section of your tailwind.config.js:

  './node_modules/@activix/ui/**/*.{vue,js}',
  

Contributing

Development Setup

After cloning the repo, run:

npm install

Commonly used NPM scripts

# Compiles and hot-reloads for development
npm run dev

Use Local version in CRM to test

# In Activix-UI terminal run
npm link

#After that go to in CRM open new terminal cd ../frontend
npm link "@activix/ui"

#When you have finished to test
npm unlink "@activix/ui"

Deployment

We use Github Packages as NPM's registry. To publish a new version, you must follow these steps:

1. Follow the steps here to authenticate with Github Packages.
2. Execute npm version patch to tag a new version for the package.
3. Execute npm publish to publish the new version to Github Packages.