argo-cd/ui/README.md
Alex Recuenco 6a3a540c9a
docs: vscode settings recommendation is outdated (#25925)
Signed-off-by: alexrecuenco <26118630+alexrecuenco@users.noreply.github.com>
2026-01-13 10:39:00 -05:00

46 lines
1.5 KiB
Markdown

# Argo CD UI
<img src="https://github.com/argoproj/argo-cd/blob/master/ui/src/assets/images/argo.png?raw=true" alt="Argo Image" width="600" />
Web UI for [Argo CD](https://github.com/argoproj/argo-cd).
## Getting started
1. Install [NodeJS](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com). On macOS with [Homebrew](https://brew.sh/), running `brew install node yarn` will accomplish this.
2. Run `yarn install` to install local prerequisites.
3. Run `yarn start` to launch the webpack dev UI server.
4. Run `yarn build` to bundle static resources into the `./dist` directory.
To build a Docker image, run `IMAGE_NAMESPACE=yourimagerepo IMAGE_TAG=latest yarn docker`.
To do the same and push to a Docker registry, run `IMAGE_NAMESPACE=yourimagerepo IMAGE_TAG=latest DOCKER_PUSH=true yarn docker`.
## Pre-commit Checks
Make sure your code passes the lint checks:
```bash
yarn lint --fix
```
If you are using VSCode, add this configuration to `.vscode/settings.json` in the root of this repository to identify and fix lint issues automatically before you save file.
Install [Eslint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) in VSCode.
`.vscode/settings.json`
```json
{
"eslint.format.enable": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "always"
},
"eslint.workingDirectories": [
{
"directory": "./ui",
"!cwd": false
}
],
"eslint.useFlatConfig": true
}
```