dccurtis / sources-ui

Static deploy repo: https://github.com/RedHatInsights/sources-ui-deploy

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
  • Run app
  • Debug functions
• Queries
• Testing
• Patternfly
• Data-driven forms
• Insights Components
  • AddSourceWizard
  • Updating steps in the wizard
• API
  • Sources Javascript API client
• Insights Frontend Assets
• Deploying
  • How it works
• License

Getting Started

Run app

1. npm install

2. npm run start

   • starts webpack bundler and serves the files with webpack dev server on https://ci.foo.redhat.com:1337/settings/sources/

3. npm run start:beta

   • starts webpack bundler and serves the files with webpack dev server on https://ci.foo.redhat.com:1337/beta/settings/sources/

You have to be connected to Red Hat VPN.

Check our proxy documenation for more options.

Debug functions

Sources UI provides easy way how to test different states of the application when running in dev environment.

Run from the console one of following commands:

• sourcesDebug.showEmptyState

Sets number of currently loaded sources to 0. Shows empty state.

• sourcesDebug.setCount

Changes number of sources to a value you need.

• sourcesDebug.removePermissions

Removes write permissions.

• sourcesDebug.setPermissions

Grants write permissions.

Queries

You can use queries to modify the initial state of the application. Read more here.

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

ADD SOURCE WIZARD WAS MOVED TO THIS REPOSITORY!

Documentation is here.

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

Insights Frontend Assets

Static assets are deployed to Insights Frontend Assets repository. If you need to add/change/remove some icon, please do it there.

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.