Skip to content
This repository was archived by the owner on Dec 20, 2025. It is now read-only.

Commit d820af0

Browse files
authored
chore(docs): update README
1 parent 3f2418e commit d820af0

File tree

1 file changed

+2
-78
lines changed

1 file changed

+2
-78
lines changed

README.md

Lines changed: 2 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,2 @@
1-
# Spinnaker UI
2-
3-
![Branch Build](https://github.com/spinnaker/deck/workflows/Branch%20Build/badge.svg)
4-
5-
## Prerequisites
6-
7-
Make sure that [node](http://nodejs.org/download/) and [yarn](https://yarnpkg.com/en/docs/install) are installed on your system.
8-
The minimum versions for each are listed in package.json.
9-
10-
## Quick Start
11-
12-
Run the following commands (in the deck directory) to get all dependencies installed in deck and to start the server:
13-
14-
- `yarn`
15-
- `yarn modules`
16-
- `yarn start`
17-
18-
The app will start up on localhost:9000.
19-
20-
When editing `core` or any other cloud provider package, please run the following in that folder
21-
22-
- `yarn dev`
23-
24-
If your local dev setup ends up in a corrupt state with missing npm modules, please run `yarn fixup` from deck and that
25-
should reset your state.
26-
27-
## Environment variables
28-
29-
Environment variables can be used to configure application behavior. The following lists those variables and their possible values:
30-
31-
- `AUTH` enable/disable authentication (default is disabled, enable by setting `AUTH=enabled`).
32-
- `TIMEZONE` set the default timezone (default is 'America/Los_Angeles' - see http://momentjs.com/timezone/docs/#/data-utilities/ for options)
33-
- `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)
34-
35-
The following external resources can be specified with environment variables:
36-
37-
- `API_HOST` overrides the default Spinnaker API host.
38-
- `AUTH_ENABLED` determines whether Deck will attempt to authenticate users via Gate.
39-
40-
For example, `API_HOST=http://spinnaker.prod.netflix.net yarn start` will run Deck with `http://spinnaker.prod.netflix.net` as the API host.
41-
42-
## Development
43-
44-
Deck has a combination of Angular and React, but is moving to React only. New changes made to the Deck project should use React wherever possible.
45-
46-
## Testing
47-
48-
To run the tests within the application, run `yarn test`.
49-
50-
Developing things locally? You may want to run [gate](https://github.com/spinnaker/gate) locally (which runs on port 8084) as well.
51-
Gate is the service that hosts the spinnaker REST API.
52-
Then run deck like this:
53-
54-
```
55-
API_HOST=http://localhost:8084 yarn start
56-
```
57-
58-
## Building & Deploying
59-
60-
To build the application, run `yarn modules && yarn build`.
61-
The built application lives in `build/`.
62-
63-
## Graphql
64-
65-
the `core` package is using graphql queries and mutation to interact with the backend (currently, only the `managed` components).
66-
To generate the TS types and the Apollo hooks, run `yarn graphql:generate` from `core`.
67-
68-
## Conventions
69-
70-
It's a work in progress, but please try to follow the [conventions here](https://github.com/spinnaker/deck/wiki/Conventions).
71-
72-
## Customizing the UI
73-
74-
It's certainly doable - we're in the middle of some significant changes to our build process, which should make it easier.
75-
For now, you can look at the [all modules](https://github.com/spinnaker/deck/tree/master/packages/) to
76-
get an idea how we are customizing Deck internally. Expect a lot of this to change, though, as we figure out better, cleaner
77-
hooks and integration points. And we're happy to provide new integration points (or accept pull requests) following
78-
those existing conventions if you need an integration point that doesn't already exist.
1+
> [!IMPORTANT]
2+
> Deck is now maintained in the [Spinnaker monorepo](https://github.com/spinnaker/spinnaker). This repository has been archived.

0 commit comments

Comments
 (0)