mirekdlugosz / quipucords-ui

Frontend web GUI for Quipucords

Quipucords UI

Web user interface for Quipucords, based on Patternfly

Requirements

Before developing, the basic requirements:

• Your system needs to be running NodeJS version 18+ and NPM
• Docker
  • Alternatively, you can try Podman.
• And Yarn for dependency and script management.

For in-depth tooling install guidance see the contribution guidelines

Development, Quick Start

Installing

1. Clone the repository

   $ git clone https://github.com/quipucords/quipucords-ui.git
   

2. Within the repo context, install project dependencies

   $ cd quipucords-ui && yarn
   

Serving Content

This is the default context for running a local UI with a randomized mock API.

Make sure Docker is running, then run

$ yarn start

For in-depth local run guidance review the contribution guidelines

Testing

Run the tests with coverage.

$ yarn test

For in-depth testing guidance review the contribution guidelines

Contributing

Contributing encompasses repository specific requirements and the global contribution guidelines.