Skip to content

RedHatInsights/curiosity-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Curiosity Frontend

Build codecov License

A web user interface for subscription reporting, based on Patternfly

Development, Quick Start

Requirements

Before developing for Curiosity Frontend

  • Your system needs to be running NodeJS version 20+ and NPM
    • 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

Install

  1. Clone the repository

    $ git clone https://github.com/RedHatInsights/curiosity-frontend.git
    
  2. 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:*:*
    
  2. In a terminal instance that uses the repo context... Run
    $ npm start
    
  3. 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
    $ 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

Contributing encompasses repository specific requirements.