Skip to content

huskar-org/huskar-console

Repository files navigation

Huskar Console

The web console of Huskar.

Demo

Getting Started

You should create a .env file (from .env.example) for development in local.

Example:

$ cat .env
NODE_ENV=development
HUSKAR_API_URL=http://huskar-api.example.com

Then you could use the presented npm scripts:

$ npm install                    # install dependencies
$ npm run clean                  # clean dist directory
$ npm run build                  # build only
$ npm start                      # start the development server
$ npm test                       # run tests

Deployment

There is a series of configuration items as environment variables:

Name Context Required Default
NODE_ENV Compile time Required development
HUSKAR_SENTRY_DSN Runtime Optional
HUSKAR_MONITOR_URL Runtime Optional https://monitor.example.com
HUSKAR_AMQP_DASHBOARD_URL Runtime Optional
HUSKAR_ES_DASHBOARD_URL Runtime Optional
HUSKAR_FEATURE_LIST Runtime Optional stateswitch
HUSKAR_EZONE_LIST Runtime Optional global,alta1,altb1
HUSKAR_CLUSTER_SPEC_URL Runtime Optional
HUSKAR_DEFAULT_CLUSTER Runtime Optional
HUSKAR_ROUTE_ADMIN_ONLY_EZONE Runtime Optional

Available feature flags:

  • signup
  • createapp
  • stateswitch
  • delaybutton
  • infrarawurl

Development Knowledge

Languages

Toolchains

Frameworks and Libraries

Apps

The devdocs is useful for looking up API of those stuff.

Best Practices

  • Pass all eslint rules
  • Write pure and micro components instead of stateful and huge components
  • Use GA to track new features