AlpineBits DestinationData Proxy

This is a reference implementation for an AlpineBits DestinationData server. The server exposes data from the OpenDataHub API in accordance to the AlpineBits format.

However, the main purpose of this application is to operate as proxy to forward requests to the dedicated versions of the reference implementation.

Additionally, this project also hosts the OpenAPI specification of the reference implementation. For detailed instructions regarding the OpenAPI specification, click here.

Table of contents

• AlpineBits DestinationData Proxy
  • Table of contents
  • Getting started
    • Prerequisites
    • Source code
    • Execute
  • Information
    • Guidelines
    • Support
    • Contributing
    • Documentation
    • License

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:

• Docker
• Docker Compose

Source code

Get a copy of the repository:

git clone https://github.com/noi-techpark/ odh-alpinebits-destination-data-proxy.git

Change directory:

cd  odh-alpinebits-destination-data-proxy/

Execute

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

Then you can start the application using the following command:

docker-compose up

The service will be available at http://localhost:8080.

Information

Guidelines

Find here guidelines for developers.

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.

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