Sustainability Apps

A web component displaying statistics for various sustainability apps used in South Tyrol. Currently, the web component only supports Suedtirol Radelt but Lock.All and Ummadum will be included soon.

• webcomp-sustainability-apps
  • Usage
    • Attributes
      • Font color
      • Language
      • Showing sustainability action filter
      • Selected organisation
  • Getting started
    • Prerequisites
    • Source code
    • Dependencies
    • Build
  • Tests and linting
  • Deployment
  • Run with docker
    • Installation
    • Start the docker containers
    • Publish a new version of your webcomponent
    • Stop the docker containers
    • Delete your webcomponents from the store
  • Information
    • Support
    • Contributing
    • Documentation
    • Boilerplate
    • License

Usage

Include the webcompscript file dist/sustainability-apps.umd.js in your HTML and define the web component like this:

<sustainability-apps
  fontColor="#000"
  language="en"
  showSustainabilityActionFilter="true"
  showOrganizationFilter="true" />

Attributes

Font color

The font color in hex format (e.g. #000000 for black).

Type: string Default: '#000000'

Language

Two letter key for the language to be used.

Type: string Default: 'en'

Showing sustainability action filter

Option whether the sustainability action filter is showing or not.

Type: boolean Default: true

Showing the organization filter

Option whether the organization-filter is showing or not.

Type: boolean Default: true

Selected organisation

Presets the organization-filter with this value.

Type: string Required: false

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To build the project, the following prerequisites must be met:

• Node 12 / NPM 6

For a ready to use Docker environment with all prerequisites already installed and prepared, you can check out the Docker environment section.

Source code

Get a copy of the repository:

git clone https://github.com/noi-techpark/webcomp-sustainability-apps.git

Change directory:

cd webcomp-sustainability-apps/

Dependencies

Download all dependencies:

npm install

Build

Build and start the project:

npm run start

The application will be served and can be accessed at http://localhost:8080.

Tests and linting

The tests and the linting can be executed with the following commands:

npm run test
npm run lint

Deployment

To create the distributable files, execute the following command:

npm run build

Information

Support

For support, please contact help@opendatahub.com.

Contributing

If you'd like to contribute, please follow the following instructions:

• Fork the repository.
• Checkout a topic branch from the main branch.
• Make sure the tests are passing.
• Create a pull request against the main branch.

A more detailed description have a look at our Getting Started Guide.

Documentation

More documentation can be found at https://docs.opendatahub.com.

Boilerplate

The project uses this boilerplate: https://github.com/noi-techpark/webcomp-boilerplate.

License

The code in this project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 license. See the LICENSE.md file for more information.

REUSE

This project is REUSE compliant, more information about the usage of REUSE in NOI Techpark repositories can be found here.

Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The pre-commit-config file in the repository root is already configured to check for REUSE compliance with help of the pre-commit tool.

Install the tool by running:

pip install pre-commit

Then install the pre-commit hook via the config file by running:

pre-commit install