lelebus / template-webcomponent

Boilerplate for our web components

Replace all ToDo notes in this file and adjust also the following files: - package.json: - Adjust the general parts like name, description, ... - Adjust the three scripts npm run start, npm run build and npm run test - wcs-manifest.json: - Adjust the general parts like title, description, ... - Adjust the configuration part with all possible configuration options (https://webcomponents.opendatahub.bz.it/getting-started)

ToDo: Project Name

ToDo: Description of the project.

Table of contents

• Usage
• Gettings started
• Tests and linting
• Deployment
• Docker environment
• Information

Usage

ToDo: Include the webcompscript file dist/webcomp-boilerplate.min.js in your HTML and define the web component like this:

<webcomp-boilerplate xxx="test" yyy="2"></webcomp-boilerplate>

Attributes

xxxx

The description of the parameter xxx.

Type: string Options: "test", "123"

yyy

The description of the parameter yyy.

Type: int

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:

• ToDo: Check the prerequisites
• 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:

ToDo: git clone https://github.com/noi-techpark/project-name.git

Change directory:

ToDo: cd project-name/

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

Docker environment

For the project a Docker environment is already prepared and ready to use with all necessary prerequisites.

These Docker containers are the same as used by the continuous integration servers.

Installation

Install Docker (with Docker Compose) locally on your machine.

Dependenices

First, install all dependencies:

docker-compose run --rm app /bin/bash -c "npm install"

Start and stop the containers

Before start working you have to start the Docker containers:

docker-compose up --build --detach

After finished working you can stop the Docker containers:

docker-compose stop

Running commands inside the container

When the containers are running, you can execute any command inside the environment. Just replace the dots ... in the following example with the command you wish to execute:

docker-compose run --rm app /bin/bash -c "..."

Some examples are:

docker-compose run --rm app /bin/bash -c "npm run test"

Information

Support

ToDo: For support, please contact [email protected].

Contributing

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

• Fork the repository.

• Checkout a topic branch from the development branch.

• Make sure the tests are passing.

• Create a pull request against the development branch.

A more detailed description can be found here: https://github.com/noi-techpark/documentation/blob/master/contributors.md.

Documentation

More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.

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.