<commit_before>[![Travis Build Status](https://travis-ci.org/ulaval/modul-components.svg?branch=develop)](https://travis-ci.org/ulaval/modul-components)
[![CircleCI Build Status](https://circleci.com/gh/ulaval/modul-components/tree/develop.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/ulaval/modul-components)
[![npm version](https://badge.fury.io/js/%40ulaval%2Fmodul-components.svg)](https://badge.fury.io/js/%40ulaval%2Fmodul-components)

# modul-components

A set of VueJS components for MOD**UL** web applications (beta release).

## Documentation

[Check out our documentation](https://ulaval.github.io/modul)

## Getting started to use modul in your project

### Prerequisites

- vue
- vue-router
- webpack
- sass

### Start a new modul application and webpack configuration

Please refer to [this repository](https://github.com/simardo/vuejs-typescript-template) for a template of a modul project using vue-cli 2.x

You can also check [this repository](https://github.com/chuckmah/my-cli-module-project) for an example of a modul project using vue-cli 3+

## Contributing

### Deploy sandboxes

1. Clone this project and install using npm install
2. Run npm run setup
3. Run npm run dev

### Deployment for local usage

1. Run npm pack
2. Add the dependency in your package.json ("@ulaval/modul-components": "file://&lt;path-to&gt;\\ulaval-modul-components-&lt;version&gt;.tgz")

> The `npm pack` command produces multiple .js files along with their definition files (.d.ts), html templates, scss files, etc.<commit_msg>updated readme (#615)<commit_after>[![Travis Build Status](https://travis-ci.org/ulaval/modul-components.svg?branch=develop)](https://travis-ci.org/ulaval/modul-components)
[![CircleCI Build Status](https://circleci.com/gh/ulaval/modul-components/tree/develop.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/ulaval/modul-components)
[![npm version](https://badge.fury.io/js/%40ulaval%2Fmodul-components.svg)](https://badge.fury.io/js/%40ulaval%2Fmodul-components)

# modul-components

A set of VueJS components for MOD**UL** web applications (beta release).

## Documentation

[Check out our documentation](https://ulaval.github.io/modul)

## Getting started to use modul in your project

### Prerequisites

- vue
- vue-router
- webpack
- typescript
- sass

### Start a new modul application and webpack configuration

Please refer to [this repository](https://github.com/ulaval/modul-typescript-template) for a template of a modul project.

## Contributing

### Deploy sandboxes

1. Clone this project and install using npm install
2. Run npm run setup
3. Run npm run dev

### Deployment for local usage in your project

1. Run npm pack
2. Add the dependency in your package.json ("@ulaval/modul-components": "file://&lt;path-to&gt;\\ulaval-modul-components-&lt;version&gt;.tgz")

> The `npm pack` command produces multiple .js files along with their definition files (.d.ts), html templates, scss files, etc.
{'fraction_non_alphanumeric': 0.13869346733668342, 'fraction_numerical': 0.009045226130653266, 'mean_word_length': 4.912871287128713, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 17, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1387784', 'n_tokens_mistral': 992, 'n_tokens_neox': 952, 'n_words': 256}