Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 12-Feb-2019 | - | ||||
app/ | H | 03-May-2022 | - | 18,267 | 17,204 | |
config/ | H | 03-May-2022 | - | 4 | 3 | |
lib/css/ | H | 03-May-2022 | - | 7 | 6 | |
public/ | H | 03-May-2022 | - | |||
scripts/ | H | 03-May-2022 | - | |||
tests/ | H | 03-May-2022 | - | |||
vendor/ | H | 03-May-2022 | - | |||
.editorconfig | H A D | 12-Feb-2019 | 419 | 26 | 18 | |
.ember-cli | H A D | 12-Feb-2019 | 313 | 11 | 9 | |
.eslintignore | H A D | 12-Feb-2019 | 250 | 20 | 15 | |
.gitignore | H A D | 12-Feb-2019 | 355 | 24 | 19 | |
.nvmrc | H A D | 12-Feb-2019 | 8 | 2 | 1 | |
.prettierrc | H A D | 12-Feb-2019 | 73 | 6 | 5 | |
.watchmanconfig | H A D | 12-Feb-2019 | 37 | 4 | 3 | |
README.md | H A D | 12-Feb-2019 | 2.9 KiB | 84 | 57 | |
package.json | H A D | 12-Feb-2019 | 4.2 KiB | 136 | 135 | |
yarn.lock | H A D | 12-Feb-2019 | 538.5 KiB | 13,643 | 11,875 |
README.md
1# vault 2 3This README outlines the details of collaborating on this Ember application. 4A short introduction of this app could easily go here. 5 6## Prerequisites 7 8You will need the following things properly installed on your computer. 9 10- [Node.js](https://nodejs.org/) (with NPM) 11- [Yarn](https://yarnpkg.com/en/) 12- [Git](https://git-scm.com/) 13- [Ember CLI](https://ember-cli.com/) 14- [Husky\*](https://github.com/typicode/husky) 15- [lint-staged\*](https://www.npmjs.com/package/lint-staged) 16 17\* Husky and lint-staged are optional dependencies - running `yarn` will install them. 18If don't want them installed (husky adds files for every hooks in `.git/hooks/`), 19then you can run `yarn --ignore-optional`. If you've ignored the optional deps 20previously and want to install them, you have to tell yarn to refetch all deps by 21running `yarn --force`. 22 23## Running / Development 24 25To get all of the JavaScript dependencies installed, run this in the `ui` directory: 26 27`yarn` 28 29If you want to run Vault UI and proxy back to a Vault server running 30on the default port, 8200, run the following in the `ui` directory: 31 32- `yarn run start` 33 34This will start an Ember CLI server that proxies requests to port 8200, 35and enable live rebuilding of the application as you change the UI application code. 36Visit your app at [http://localhost:4200](http://localhost:4200). 37 38If your Vault server is running on a different port you can use the 39long-form version of the npm script: 40 41`ember server --proxy=http://localhost:PORT` 42 43### Code Generators 44 45Make use of the many generators for code, try `ember help generate` for more details 46 47### Running Tests 48 49Running tests will spin up a Vault dev server on port 9200 via a 50pretest script that testem (the test runner) executes. All of the 51acceptance tests then run, proxing requests back to that server. 52 53- `yarn run test-oss` 54- `yarn run test-oss -s` to keep the test server running after the initial run. 55- `yarn run test -f="policies"` to filter the tests that are run. `-f` gets passed into 56 [QUnit's `filter` config](https://api.qunitjs.com/config/QUnit.config#qunitconfigfilter-string--default-undefined) 57 58### Linting 59 60- `yarn lint:hbs` 61- `yarn lint:js` 62- `yarn lint:js -- --fix` 63 64### Building Vault UI into a Vault Binary 65 66We use `go-bindata-assetfs` to build the static assets of the 67Ember application into a Vault binary. 68 69This can be done by running these commands from the root directory run: 70`make static-dist` 71`make dev-ui` 72 73This will result in a Vault binary that has the UI built-in - though in 74a non-dev setup it will still need to be enabled via the `ui` config or 75setting `VAULT_UI` environment variable. 76 77## Further Reading / Useful Links 78 79- [ember.js](http://emberjs.com/) 80- [ember-cli](https://ember-cli.com/) 81- Development Browser Extensions 82 - [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) 83 - [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) 84