andresgalante / koku-ui

Koku UI

Koku UI

User interface for Koku based on Patternfly

Requirements

• NodeJS v8+
• yarn 1.5+

Getting Started

1. Install requirements listed above.
2. Clone repo, and open a terminal in the base of this project.
3. Run the command yarn to install all the dependencies.

Running Development Server against a local running Koku

Follow this Getting Started Guide to setup koku api.

yarn start

Running Development Server against a hosted Koku instance

APP_NAMESPACE=koku-{dev|staging} yarn start

As a convenience start:dev has been provided to target the hosted dev enviornment.

yarn start:dev

Building

yarn build

Testing

yarn test

Useful Links

Libs

• TypeScript
• React
• Redux - State Management
  • Redux-Thunk - Middleware for returning functions from actions (gives access to dispatch and getState to action)
  • typesafe-actions - Typesafe Redux
  • Selectors
• Axios - HTTP Client
• React Router
  • withRouter - Injects components with route props
  • Link
  • Route
• React I18Next - React Wrapper for i18next
• PatternFly React 4
  • Source - react-*/**
  • PRS
  • Issues

Tools

• React Devtools
  • Chrome
  • Firefox
• Redux Devtools
  • Chrome
  • Firefox
• VSCode
  • TSLint - Linting
    • In Settings add

    {
      ...
      "tslint.autoFixOnSave": true,
      ...
    }

  • Prettier - Autoformat
    • In settings add:

    {
      ...
      "[typescript]": {
        "editor.formatOnSave": true
      },
      "[typescriptreact]": {
          "editor.formatOnSave": true
      },
      ...
    }

  • Docker - Manage Docker images from VSCode