README.md

Quipucords UI

Web user interface for Quipucords, based on Patternfly

Development, Quick Start

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

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
   

Develop

This is the base context for running a local UI against a mock API.

1. Create a local dotenv file called .env.local and add the following contents

   REACT_APP_DEBUG_MIDDLEWARE=true
   

2. Make sure Docker/Podman is running
3. In a terminal instance that uses the repo context... Run

   $ yarn start
   

4. Start developing against files in ./src. Linting feedback will be automatically enabled through the terminal output

For in-depth local run guidance review the contribution guidelines

Unit testing

Run and update unit tests while developing instead of after-the-fact. In a new terminal instance

1. In a new terminal instance that uses the repo context... Run

   $ yarn test:dev
   

2. Test files can be accessed, and edited, under __test__ directories parallel to the files you're editing. Test failures for recently edited files will be available in the terminal output along with basic testing framework use directions.

For in-depth testing guidance review the contribution guidelines

Contributing

Contributing encompasses repository specific requirements and the global contribution guidelines.