hgallo/deck repository overview

= Spinnaker UI

image::https://api.travis-ci.org/spinnaker/deck.svg?branch=master["Build⁠ Status", link="https://travis-ci.org/spinnaker/deck⁠"]

== Prerequisites

Make sure that http://nodejs.org/download/[node⁠] and https://yarnpkg.com/en/docs/install[yarn⁠] are installed on your system. The minimum versions for each are listed in package.json.

== Quick Start

Run the following commands (in the deck directory) to get all dependencies installed in deck and to start the server:

• yarn
• yarn run start

The app will start up on localhost:9000.

== Environment variables

Environment variables can be used to configure application behavior. The following lists those variables and their possible values:

• AUTH enable/disable authentication (default is disabled, enable by setting AUTH=enabled).
• TIMEZONE set the default timezone (default is 'America/Los_Angeles' - see http://momentjs.com/timezone/docs/#/data-utilities/⁠ for options)
• DECK_CERT enable SSL (set to the fully qualified path to cert file, and DECK_KEY must be set to the fully qualified path to the key file)

The following external resources can be specified with environment variables:

• API_HOST overrides the default Spinnaker API host.
• AUTH_ENABLED determines whether Deck will attempt to authenticate users via Gate.

For example, API_HOST=http://spinnaker.prod.netflix.net yarn run start will run Deck with http://spinnaker.prod.netflix.net as the API host.

== Testing

To run the tests within the application, run yarn run test.

⁠[[NOTE]]

Developing things locally? You will want to run https://github.com/spinnaker/gate[gate⁠] locally (which runs on port 8084) as well. It's the gateway to clouddriver. Then run deck like this:

API_HOST=http://localhost:8084 yarn run start

====

== Building & Deploying

To build the application, run yarn run build. The built application lives in build/.

== Conventions

It's a work in progress, but please try to follow the https://github.com/spinnaker/deck/wiki/Conventions[conventions⁠ here].

== Customizing the UI

It's certainly doable - we're in the middle of some significant changes to our build process, which should make it easier. For now, you can look at the https://github.com/spinnaker/deck/tree/master/app/scripts/modules/netflix[netflix⁠ module] to get an idea how we are customizing Deck internally. Expect a lot of this to change, though, as we figure out better, cleaner hooks and integration points. And we're happy to provide new integration points (or accept pull requests) following those existing conventions if you need an integration point that doesn't already exist.