README.md
1# Nomad UI
2
3The official Nomad UI.
4
5## Prerequisites
6
7This is an [ember.js](https://emberjs.com/) project, and you will need the following tools installed on your computer.
8
9* [Node.js v10](https://nodejs.org/)
10* [Yarn](https://yarnpkg.com)
11* [Ember CLI](https://ember-cli.com/)
12
13## Installation
14
15The Nomad UI gets cloned along with the rest of Nomad. To install dependencies, do the following from the root of the Nomad project:
16
17```
18$ cd ui
19$ yarn
20```
21
22## Running / Development
23
24UI in development mode defaults to using fake generated data, but you can configure it to proxy a live running nomad process by setting `USE_MIRAGE` environment variable to `false`. First, make sure nomad is running. The UI, in development mode, runs independently from Nomad, so this could be an official release or a dev branch. Likewise, Nomad can be running in server mode or dev mode. As long as the API is accessible, the UI will work as expected.
25
26* `USE_MIRAGE=false ember serve`
27* Visit your app at [http://localhost:4200](http://localhost:4200).
28
29You may need to reference the direct path to `ember`, typically in `./node_modules/.bin/ember`.
30
31The fake data in development is generated from a stable seed of 1. To generate different data, you can include a query parameter of `?faker-seed=2` or any other number in the URL. To turn off the seed and get different data with every load, use `?faker=seed=0`.
32
33When running with Mirage, the default scenario is set in `config/environment.js` but can be overridden with a query parameter to any of the scenarios named in `mirage/scenarios/default.js` with something like `?mirage-scenario=emptyCluster`.
34
35## Running / Development with Vagrant
36
37All necessary tools for UI development are installed as part of the Vagrantfile. This is primarily to make it easy to build the UI from source while working on Nomad. Due to the filesystem requirements of [Broccoli](http://broccolijs.com/) (which powers Ember CLI), it is strongly discouraged to use Vagrant for developing changes to the UI.
38
39That said, development with Vagrant is still possible, but the `ember serve` command requires two modifications:
40
41* `--watch polling`: This allows the vm to notice file changes made in the host environment.
42* `--port 4201`: The default port 4200 is not forwarded, since local development is recommended.
43
44This makes the full command for running the UI in development mode in Vagrant:
45
46```
47$ ember serve --watch polling --port 4201
48```
49
50### Running Tests
51
52Nomad UI tests can be run independently of Nomad golang tests.
53
54* `ember test` (single run, headless browser)
55* `ember test --server` (watches for changes, runs in a full browser)
56
57You can use `--filter <test name>` to run a targetted set of tests, e.g. `ember test --filter 'allocation detail'`.
58
59In the test environment, the fake data is generated with a random seed. If you want stable data, you can set a seed while running the test server by appending `&faker-seed=1` (or any other non-zero number) to the URL.
60
61### Linting
62
63Linting should happen automatically in your editor and when committing changes, but it can also be invoked manually.
64
65* `npm run lint:hbs`
66* `npm run lint:js`
67* `npm run lint:js -- --fix`
68
69### Building
70
71Typically `make release` or `make dev-ui` will be the desired build workflow, but in the event that build artifacts need to be inspected, `ember build` will output compiled files in `ui/dist`.
72
73* `ember build` (development)
74* `ember build --environment production` (production)
75
76### Releasing
77
78Nomad UI releases are in lockstep with Nomad releases and are integrated into the `make release` toolchain.
79
80### Conventions
81
82* UI branches should be prefix with `f-ui-` for feature work and `b-ui-` for bug fixes. This instructs CI to skip running nomad backend tests.
83
84### Storybook UI Library
85
86The Storybook project provides a browser to see what components and patterns are present in the application and how to use them. You can run it locally with `yarn storybook` after you have `ember serve` running. The latest version from the `main` branch is at [`nomad-storybook-and-ui.vercel.app/storybook/`](https://nomad-storybook-and-ui.vercel.app/storybook/).
87
88To generate a new story for a component, run `ember generate story component-name`. You can use the existing stories as a guide.
89
90### Troubleshooting
91
92#### The UI is running, but none of the API requests are working
93
94By default (according to the `.ember-cli` file), a proxy address of `http://localhost:4646` is used. If you are running Nomad at a different address, you will need to override this setting when running ember serve: `ember serve --proxy http://newlocation:1111`.
95
96Also, ensure that `USE_MIRAGE` environment variable is set to false, so the UI proxy requests to Nomad process instead of using autogenerated test data.
97
98#### Nomad is running in Vagrant, but I can't access the API from my host machine
99
100Nomad binds to `127.0.0.1:4646` by default, which is the loopback address. Try running nomad bound to `0.0.0.0`: `bin/nomad -bind 0.0.0.0`.
101
102Ports also need to be forwarded in the Vagrantfile. 4646 is already forwarded, but if a port other than the default is being used, that port needs to be added to the Vagrantfile and `vagrant reload` needs to be run.
103