Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endurancecode/endurancetrio-web-components
Set of web components to be used with the EnduranceTrio applications system
https://github.com/endurancecode/endurancetrio-web-components
eslint javascript lit lit-element lit-html webcomponents webpack
Last synced: 16 days ago
JSON representation
Set of web components to be used with the EnduranceTrio applications system
- Host: GitHub
- URL: https://github.com/endurancecode/endurancetrio-web-components
- Owner: EnduranceCode
- License: mit
- Created: 2021-10-30T10:52:04.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T16:26:23.000Z (10 months ago)
- Last Synced: 2024-04-11T03:08:42.351Z (10 months ago)
- Topics: eslint, javascript, lit, lit-element, lit-html, webcomponents, webpack
- Language: JavaScript
- Homepage:
- Size: 2.67 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EnduranceTrio Web Components
**Set of *Web Components*, built with *LitElement*, aimed for the EnduranceTrio applications system.**
## Table Of Contents
1. [Introduction](#introduction)
2. [Development](#development)
1. [Technologies](#technologies)
2. [Installation](#installation)
3. [License](#license)
## Introduction
**EnduranceTrio Web Components** is a set of [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components), built with [LitElement](https://lit.dev/), aimed for the EnduranceTrio applications system.
## Development
For the development of **EnduranceTrio Web Components**, [Webpack](https://webpack.js.org/) is used and therefore [node](https://nodejs.org/) (and [npm](https://www.npmjs.com/)) must be installed in the development machine.
### Technologies
#### Tools
**EnduranceTrio Web Components** uses the following [npm](https://www.npmjs.com/) packages for its development:
+ [css-loader](https://www.npmjs.com/package/css-loader);
+ [dotenv](https://www.npmjs.com/package/dotenv);
+ [eslint](https://www.npmjs.com/package/eslint);
+ [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier);
+ [eslint-plugin-prettier](https://www.npmjs.com/package/eslint-plugin-prettier);
+ [eslint-plugin-wc](https://www.npmjs.com/package/eslint-plugin-wc);
+ [html-webpack-plugin](https://www.npmjs.com/package/html-webpack-plugin);
+ [prettier](https://www.npmjs.com/package/prettier);
+ [sass](https://www.npmjs.com/package/sass);
+ [sass-loader](https://www.npmjs.com/package/sass-loader);
+ [webpack](https://www.npmjs.com/package/webpack);
+ [webpack-cli](https://www.npmjs.com/package/webpack-cli);
+ [webpack-dev-server](https://www.npmjs.com/package/webpack-dev-server).
#### Build
**EnduranceTrio Web Components** is built with [LitElement](https://lit.dev/). The styling of the its components is based on [Bulma](https://bulma.io/) and the used icon library is [Material Design Icons](https://pictogrammers.com/library/mdi/). [Bulma](https://bulma.io/) is also used for the styling of **EnduranceTrio Web Components** sample page. Therefore, the following [npm](https://www.npmjs.com/) packages are used to build **EnduranceTrio Web Components**:
+ [lit](https://www.npmjs.com/package/lit);
+ [bulma](https://www.npmjs.com/package/bulma);
+ [@mdi/js](https://www.npmjs.com/package/@mdi/js);
+ [jsPDF](https://www.npmjs.com/package/jspdf);
+ [jsPDF-AutoTable](https://www.npmjs.com/package/jspdf-autotable).
### Installation
To start developing **EnduranceTrio Web Components**, clone this repository and install the required [npm](https://www.npmjs.com/) packages with the following command:
git clone [email protected]:EnduranceCode/endurancetrio-web-components.git
cd endurancetrio-web-components
npm install
To setup the environment variables file, copy the file [`.env.template`](.env.template) as `.env.development`and 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](./LICENSE).