webcomp-configtool

A web component that allows to graphically configure other web components via manifest files.

Table of contents

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

Usage

Include the Javascript file dist/wcs-config-tool.min.js in your HTML and define the web component like this:

<wcs-config-tool></wcs-config-tool>

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 / Yarn 1

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-configtool.git

Change directory:

cd webcomp-configtool/

Dependencies

Download all dependencies:

yarn install

Build

Build and start the project:

yarn run build

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

Tests and linting

The linting can be executed with the following command:

npm run lint

Deployment

To create the distributable files, execute the following command:

yarn 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 "yarn install"

Start and stop the containers

Before start working you have to start the Docker containers:

docker-compose up --build --detach

See docker-compose.yml to know which port is used to access the application.

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 "yarn run lint"

Information

Support

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.