CDH Vue Lib

The Centre for Digital Humanities (CDH) Vue library is a collection of reusable Vue components and utilities designed for Vue 3 applications developed at the CDH (mainly the Portal Development team). This library is built on top of Bootstrap 5 and FontAwesome 6.

Installation

If you are using NPM:

npm install git+https://github.com/CentreForDigitalHumanities/Vue-lib.git

If you are using Yarn:

yarn add git+https://github.com/CentreForDigitalHumanities/Vue-lib.git

If you need a specific version, use one of the commands above with the version tag. For example, to install version 0.5.8 with NPM, you can use:

npm install git+https://github.com/CentreForDigitalHumanities/Vue-lib.git#v0.5.8

Interactive demo

The components can be tested interactively by running the Nuxt application in the vue-lib-doc directory.

To do this, follow these steps:

1. Clone the repository to your local machine:

   git clone https://github.com/CentreForDigitalHumanities/Vue-lib

2. Navigate to the vue-lib-doc directory:

    cd Vue-lib/vue-lib-doc

3. Install the dependencies:

   As an NPM user:

   npm install

   As a Yarn user:

   yarn install

4. Start the development server:

   As an NPM user:

   npm run dev

   As a Yarn user:

   yarn dev

5. Open your web browser and navigate to http://localhost:3000 to view the interactive demo of the components.