Skip to content

Latest commit

 

History

History
167 lines (100 loc) · 5.11 KB

README.md

File metadata and controls

167 lines (100 loc) · 5.11 KB
Raw

Data Browser for the Open Data Hub

REUSE Compliance

This is the repository for the Open Data Hub Data Browser.

Table of Contents

Getting started

These instructions will get you a copy of this repository and prepare it for development of the Data Browser.

Prerequisites

To build the projects in the repository, the following prerequisites must be met:

Installing

Get a copy of the repository, e.g. by cloning it from the following location:

git clone https://github.com/noi-techpark/it.bz.opendatahub.databrowser

Change into the databrowser directory:

cd it.bz.opendatahub.databrowser/databrowser

Install the dependencies:

npm install

Copy the file .env.example to .env and adjust the configuration parameters if required.

Start the development server:

npm run dev

On successful start, the Data Browser application can be found at http://localhost:3000.

Build for production

Before proceeding, please ensure that you are in the databrowser directory.

Build the production version:

npm run build

The result, found in the ./dist folder, can be deployed to a web server.

Launch local production server:

npm run start

Docker environment

Before proceeding, please ensure that you are in the databrowser directory.

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.

In order to use the Docker environment, you must have Docker installed locally on your machine, together with Docker Compose.

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 exec node /bin/bash -c "..."

Some examples are:

docker-compose exec node /bin/bash -c "npm install"

# or

docker-compose exec node /bin/bash -c "npm run dev"

# or

docker-compose exec node /bin/bash -c "npm run build"

Information

Support

For support, please contact Christian Gapp or NOI Techpark Südtirol - Alto Adige.

Contributing

Please take a look at the Contributor Guidelines.

You can find an introduction on how to start developing in the contribute-to-development and guideline files.

Versioning

This project uses SemVer for versioning. For the versions available, see the tags on this repository.

License

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

Reuse

This project aims to be REUSE compliant. All files contained in the repository either have to be mentioned in the dep5 file or preferably contain a header containing SPDX copyright and licensing information.

The project is checked for licensing and copyright information before every commit by a pre-commit hook if the reuse-helper-tool is installed as well as in the github CI which will fail if REUSE standards are not satisfied. Instructions for the installation of the helper tool here. If you want to use the helper tool via pipx run consider setting an alias for the command reuse to enable the pre commit hook to execute the lint.

alias reuse="pipx run reuse"

For more information on how to make new files REUSE compliant check the project guidline.

Authors

  • Christian Gapp - Initial work - gappc
  • AboutBits - Initial work - AboutBits
  • FlashBeing - Lots of contributions FlashBeing
  • NOI Support Team - Configurations and tests

Acknowledgements