An open API service indexing awesome lists of open source software.

https://github.com/open-component-model/odg-ui

UI Components of ODG (github.com/open-component-model/open-delivery-gear)
https://github.com/open-component-model/odg-ui

compliance delivery javascript ocm odg open-delivery-gear toolkit

Last synced: 19 days ago
JSON representation

UI Components of ODG (github.com/open-component-model/open-delivery-gear)

Awesome Lists containing this project

README

          

# Open Delivery Gear UI

[![REUSE status](https://api.reuse.software/badge/github.com/open-component-model/odg-ui)](https://api.reuse.software/info/github.com/open-component-model/odg-ui)

![tests](https://github.com/open-component-model/odg-ui/actions/workflows/non-release.yaml/badge.svg)
![release](https://github.com/open-component-model/odg-ui/actions/workflows/release.yaml/badge.svg)

This repository is used for developing the `Delivery Dashboard`, which is part of the Open
Delivery Gear. It is run against the `Delivery Service` as backing API and displays delivery
metadata for OCM-based deliveries.

It is written in `javascript` and uses `react` as well as the react component
framework `material-ui`.

## Development

To run the local dev server run:

`npm start`

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

For startup, `Delivery-Dashboard` requires a running instance of `Delivery-Service`.
It can be configured by passing the `REACT_APP_DELIVERY_SERVICE_API_URL` environment
variable to the npm-build cmd.

## Code style

Make use of [eslint](https://eslint.org/) and use our config `.eslintrc.yml`.
Also, it is recommended to install a pre-push hook executing `eslint`.
Please note that linter plugins are expected to be installed in global npm context.
Either install them via `npm install -g` or adjust `.ci/lint` accordingly.

```
> cat odg-ui/.git/hooks/pre-push

#!/usr/bin/env sh
set -e
repo_dir=$(readlink -f $(dirname $0)/../..)
${repo_dir}/.ci/lint
```

Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo