Skip to content
This repository has been archived by the owner on May 11, 2021. It is now read-only.

Latest commit

 

History

History
133 lines (85 loc) · 3.63 KB

DOC.md

File metadata and controls

133 lines (85 loc) · 3.63 KB
Raw

Creating a cloud.redhat.com application

Setup for development

For new employees

  1. Make sure you have node, npm, and git installed on your machine
  2. If you haven't yet, set up an ssh key for Github. Docs
  3. OSX users only Should you encounter an error during exe of a run.sh script stating python2: command not found, then you'll need to create a symlink back to python2.7 like so: sudo ln -s /usr/bin/python2.7 /usr/local/bin/python2

Docker

This project uses Docker for development. You will need to download it in order to run the proxy container.

  • You can curl a script to bypass the downloading. You will still have to run each application yourself as noted in the "Running and Developing" section below *
sh <(curl https://gist.githubusercontent.com/ryelo/efdf27b0b5a6d9c70f8e63b0abc1deaa/raw/f21dbc04443a61cf21d28a3d47467b4e072321bc/red-hat-insights-env.sh)

Proxy

Container that provides ESI and routing tools

  1. Clone the Proxy

    git@github.com:RedHatInsights/insights-proxy.git

  2. Install dependencies

    npm install

  3. Setup the initial /etc/hosts entries (do this once)

    sudo bash scripts/patch-etc-hosts.sh

  4. Pull/Update the proxy container

    bash scripts/update.sh

Chrome

Wraps your application and provides header, footer, navigation, styles, and a js library to interact with chrome directly.

  1. Clone Chrome

    git@github.com:RedHatInsights/insights-chrome.git

  2. Install dependencies

    npm install

  3. Run the build

    npm run build

Starter App

Bootstrapped application with essential tools for rapid development

  1. Clone the Starter App

    git@github.com:RedHatInsights/insights-frontend-starter-app.git

  2. Install dependencies

    npm install

Running and Developing

If you used the download script, pick back up here.

Proxy

Default Configuration

  1. Run the container with default options

    SPANDX_CONFIG=path/to/insights-frontend-starter-app/profiles/local-frontend.js sh path/to/insights-proxy/scripts/run.sh
    • NOTE: if you get a python2: command not found error here, then you'll need to create a symlink back to python2.7 like so: sudo ln -s /usr/bin/python2.7 /usr/local/bin/python2

Starter App

  1. Build from insights-chrome/build

    SPANDX_CONFIG=../../insights-frontend-starter-app/config/spandx.config.js sh ../../insights-proxy/scripts/run.sh

  2. In another terminal tab/window inside of the insights-frontend-starter-app repo, run npm run start

  3. Navigate to https://ci.foo.redhat.com:1337/insights/starter

    If you are on Firefox, then first head to https://sso.qa.redhat.com/ and accept the self-signed certificate.

    Credentials are your rhn-engineering username / redhat

New applications

If you are a new application in the platform, you will need to update some fields if you cloned the starter application

  • package.json
    • insights.appname <- this should match your appName from cloud-services-config
  • .travis.yml
    • env.global
      • REPO
      • REPO_DIR
  • local-frontend.js & local-frontend-and-api.js
    • SECTION <- this should match your bundle
    • APP_ID <- this should match your appName from cloud-services-config
  • App.js
    • insights.chrome.identifyApp('yourAppName') <- this should match your appName from cloud-services-config