pemcg/sources-ui

Sources

List of Sources for Red Hat Cloud Services.

This application allows to

• view all sources (filtering, sorting)
• add a new source
• connect an application to a source
• remove an application from a source

Table of Contents

• Sources
• Getting Started
• Running locally
• Build app
  • Testing
• Patternfly
• Data-driven forms
• Insights Components
  • AddSourceWizard
  • Updating steps in the wizard
• API
  • Sources Javascript API client
• Technologies
• Deploying
  • How it works
• License

Getting Started

There is a comprehensive quick start guide in the Storybook Documentation to setting up an Insights environment complete with:

• Insights Frontend Starter App

• Insights Chroming

• Insights Proxy

Note: You will need to set up the Insights environment if you want to develop Sources UI due to the consumption of the chroming service as well as setting up your global/app navigation through the API.

Running locally

Have insights-proxy installed under PROXY_PATH

SPANDX_CONFIG="./config/spandx.config.js" bash $PROXY_PATH/scripts/run.sh

Build app

1. npm install

2. npm run start

   • starts webpack bundler and serves the files with webpack dev server

Testing

• Travis is used to test the build for this code.
  • npm run test will run tests,
  • npm run lint will run just the linter.

Patternfly

• This project imports Patternfly components:
  • Patternfly React

Data-driven forms

• This project uses Data-driven forms:
  • Data-driven Forms
  • Data-driven Demo

Insights Components

Red Hat Insights Frontend Components

Insights Platform will deliver components and static assets through npm. ESI tags are used to import the chroming which takes care of the header, sidebar, and footer.

AddSourceWizard

This application use a AddSourceWizard, which provides the Wizard component. For creating the DDF schema, it uses information provided by Sources API and components included in the AddSourceWizard package.

Updating steps in the wizard

• See Update wizard. This guideline provides info how to update the add source wizard.

API

• Sources API

Sources Javascript API client

This API client is no longer in the UI because of its huge bundle size. However, is useful to use is a documentation to the API.

• Sources API Javascript client

Technologies

• See Technologies.

Deploying

• The Platform team is using Travis to deploy the application

How it works

• any push to the {REPO} master branch will deploy to a {REPO}-build master branch
• any push to a {REPO} stable/\* branch will deploy to a {REPO}-build stable branch
• Pull requests (based on master) will not be pushed to {REPO}-build master branch
  • If the PR is accepted and merged, master will be rebuilt and will deploy to {REPO}-build master branch

License

This project is available as open source under the terms of the Apache License 2.0.