@vismaux/nordic-cool-vue

Visma Nordic Cool 4 Vue.js UI Library

Get started with the Nordic Cool Vue.js UI Library and experience well written, designed and tested front end code.

View Documentation

Installation

After you've created a Vue CLI Project, install the Nordic Cool Vue.js UI Library using the following command:

npm install --save @vismaux/nordic-cool-vue

Integration

By running the command above, you have added the Nordic Cool Vue.js UI Library to your Vue CLI project. Next you need to:

• Import and integrate the @vismaux/nordic-cool-vue plugin, components, and stylesheet inside in your src/main.js:

import Vue from 'vue';
import UI from '@vismaux/nordic-cool-vue';
import '@vismaux/nordic-cool-vue/dist/nc.css';

Vue.use(UI);

• Add @vismaux/nordic-cool-vue to transpileDependencies inside of your vue.config.js file. If you don't have a vue.config.js file in your project root folder, create it:

module.exports = {
    transpileDependencies: ["@vismaux/nordic-cool-vue"]
}

Customizable and Tree-shakable Integration (Typescript only)

First and foremost, you need to have a working TypeScript Vue CLI setup.

• Add Sass to your development dependencies

npm install --save-dev sass-loader node-sass

• Import and integrate the @vismaux/nordic-cool-vue plugin, components, and stylesheet inside in your src/main.js:

import Vue from 'vue';
import { UI, components } from '@vismaux/nordic-cool-vue/src';
import '@vismaux/nordic-cool-vue/src/index.scss';

Vue.use(UI, { components });

• Add @vismaux/nordic-cool-vue to transpileDependencies inside of your vue.config.js file. If you don't have a vue.config.js file in your project root folder, create it:

module.exports = {
    transpileDependencies: ["@vismaux/nordic-cool-vue"]
}

Contributing

First, you will need to get a Node.js environment up and running:

Install Node.js

a. Direct Installation

If you want to get started right away, download and install the Node.js binaries by visiting the official Node.js Downloads page.

b. Node Version Manager

The recommended way to install, keep your environment organized, and handle multiple Node.js versions to use for different applications is installing nvm. Here's how to install it for your specific operating system:

MacOS

Run the following command in your command line:

brew install nvm

nvm ls-remote
nvm install 14.17.0
nvm use 14.17.0

Linux

Follow the steps specified in the nvm GitHub repository, or run the following command in your command line:

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash

nvm ls-remote
nvm install 14.17.0
nvm use 14.17.0

Windows

The windows version requires you to Download and Install the executable from the nvm-windows GitHub repository.

nvm list available
nvm install 14.17.0
nvm use 14.17.0

Clone the project

git clone [e-mail]:Visma-net-ERP/ui.git

Start the project

npm run dev

Run your unit tests

npm run test

Run linting

npm run lint