README.md

Subscriptions Insights Frontend

Web user interface for Subscriptions Insights, based on Patternfly

Requirements

Before developing for Subscriptions Insights Frontend, the basic requirements:

• Your system needs to be running NodeJS version 10+
• Docker
• And Yarn 1.13+ for dependency and script management.

Docker & Mac

Setting Docker up on a Mac? Install the appropriate package and you should be good to go. To check if everything installed correctly you can try these steps.

• At a terminal prompt type

  $ docker run hello-world
  

Docker & Linux

Setting Docker up on a Linux machine can include an additional convenience step. If you're having to prefix "sudo" in front of your Docker commands you can try these steps.

• Docker postinstall documentation

Yarn

We recommend using Homebrew to do the install.

$ brew update
$ brew install yarn

Development, Quick Start

Installing

1. Clone the repository

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

2. Within the repo context, install project dependencies

   $ cd subscriptions-insights-frontend && yarn
   

Serving Content

This is the default context for running a local UI against mock styling.

$ 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 Insights guidelines.