EnduranceTrio Web Components

Set of Web Components, built with LitElement, aimed for the EnduranceTrio applications system.

Table Of Contents

1. Introduction
2. Development
   1. Technologies
   2. Installation
3. License

Introduction

EnduranceTrio Web Components is a set of Web Components, built with LitElement, aimed for the EnduranceTrio applications system.

Development

For the development of EnduranceTrio Web Components, Webpack is used and therefore node (and npm) must be installed in the development machine.

Technologies

Tools

EnduranceTrio Web Components uses the following npm packages for its development:

• css-loader;
• dotenv;
• eslint;
• eslint-config-prettier;
• eslint-plugin-prettier;
• eslint-plugin-wc;
• html-webpack-plugin;
• prettier;
• sass;
• sass-loader;
• webpack;
• webpack-cli;
• webpack-dev-server.

Build

EnduranceTrio Web Components is built with LitElement. The styling of the its components is based on Bulma and the used icon library is Material Design Icons. Bulma is also used for the styling of EnduranceTrio Web Components sample page. Therefore, the following npm packages are used to build EnduranceTrio Web Components:

• lit;
• bulma;
• @mdi/js;
• jsPDF;
• jsPDF-AutoTable.

Installation

To start developing EnduranceTrio Web Components, clone this repository and install the required npm packages with the following command:

git clone git@github.com:EnduranceCode/endurancetrio-web-components.git
cd endurancetrio-web-components
npm install

To setup the environment variables file, copy the file .env.template as .env.developmentand then define the variables values for the development environment. Repeat the process for the production environment, naming the correspondent environmnet variables file as .env.production.

License

EnduranceTrio Web Components is licensed under the terms of MIT License.