https://github.com/redhatinsights/curiosity-frontend

A subscription reporting frontend
https://github.com/redhatinsights/curiosity-frontend

Last synced: about 2 months ago
JSON representation

A subscription reporting frontend

• Host: GitHub
• URL: https://github.com/redhatinsights/curiosity-frontend
• Owner: RedHatInsights
• License: apache-2.0
• Created: 2019-06-06T14:16:15.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T14:57:23.000Z (about 2 months ago)
• Last Synced: 2025-04-09T15:44:55.280Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 10.4 MB
• Stars: 7
• Watchers: 20
• Forks: 20
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Curiosity Frontend

[![Build](https://github.com/RedHatInsights/curiosity-frontend/actions/workflows/integration.yml/badge.svg?branch=main)](https://github.com/RedHatInsights/curiosity-frontend/actions/workflows/integration.yml)

[![codecov](https://codecov.io/gh/RedHatInsights/curiosity-frontend/branch/main/graph/badge.svg)](https://codecov.io/gh/RedHatInsights/curiosity-frontend)

[![License](https://img.shields.io/github/license/RedHatInsights/curiosity-frontend.svg)](https://github.com/RedHatInsights/curiosity-frontend/blob/main/LICENSE)

A web user interface for subscription reporting, based on [Patternfly](https://www.patternfly.org/)

## Development, Quick Start

### Requirements

Before developing for Curiosity Frontend

 * Your system needs to be running [NodeJS version 20+ and NPM](https://nodejs.org/)

    * Yarn install is discouraged. There are dependency install issues with Yarn `1.x.x` versions.

For in-depth tooling install guidance see the [contribution guidelines](./CONTRIBUTING.md#install-tooling)

### Install

  1. Clone the repository

     ```

     $ git clone https://github.com/RedHatInsights/curiosity-frontend.git

     ```

  1. Within the repo context, install project dependencies

     ```

     $ cd curiosity-frontend && npm install

     ```

### Develop

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

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

      ```

      REACT_APP_DEBUG_MIDDLEWARE=true

      REACT_APP_DEBUG_ORG_ADMIN=true

      REACT_APP_DEBUG_PERMISSION_APP_ONE=subscriptions:*:*

      REACT_APP_DEBUG_PERMISSION_APP_TWO=inventory:*:*

     ```

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

     ```

     $ npm start

     ```

  1. 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](./CONTRIBUTING.md#local-and-proxy-development) 

### 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

     ```

     $ npm run 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.md#testing) 

## Contributing

Contributing encompasses [repository specific requirements](./CONTRIBUTING.md).