github.com/argoproj/argo-cd/v2@v2.10.9/docs/developer-guide/contributors-quickstart.md (about)

     1  # Contributors Quick-Start 
     2  
     3  This guide is a starting point for first-time contributors running Argo CD locally for the first time.
     4  
     5  It skips advanced topics such as codegen, which are covered in the [running locally guide](running-locally.md)
     6  and the [toolchain guide](toolchain-guide.md).
     7  
     8  ## Getting Started
     9  
    10  ### Install Go
    11  
    12  Install version 1.18 or newer (Verify version by running `go version`)
    13  
    14  ### Clone the Argo CD repo
    15  
    16  ```shell
    17  mkdir -p $GOPATH/src/github.com/argoproj/ &&
    18  cd $GOPATH/src/github.com/argoproj &&
    19  git clone https://github.com/argoproj/argo-cd.git
    20  ```
    21  
    22  ### Install Docker
    23  
    24  <https://docs.docker.com/engine/install/>
    25  
    26  ### Install or Upgrade `kind` (Optional - Should work with any local cluster)
    27  
    28  <https://kind.sigs.k8s.io/docs/user/quick-start/>
    29  
    30  ### Start Your Local Cluster
    31  
    32  ```shell
    33  kind create cluster
    34  ```
    35  
    36  ### Install Argo CD
    37  
    38  ```shell
    39  kubectl create namespace argocd &&
    40  kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/master/manifests/install.yaml
    41  ```
    42  
    43  Set kubectl config to avoid specifying the namespace in every kubectl command.  
    44  All following commands in this guide assume the namespace is already set.
    45  
    46  ```shell
    47  kubectl config set-context --current --namespace=argocd
    48  ```
    49  
    50  ### Install `yarn`
    51  
    52  <https://classic.yarnpkg.com/lang/en/docs/install/>
    53  
    54  ### Install `goreman`
    55  
    56  <https://github.com/mattn/goreman#getting-started>
    57  
    58  ### Run Argo CD
    59  
    60  ```shell
    61  cd argo-cd
    62  make start-local ARGOCD_GPG_ENABLED=false
    63  ```
    64  
    65  - Navigate to [localhost:4000](http://localhost:4000) in your browser to load the Argo CD UI
    66  - It may take a few minutes for the UI to be responsive
    67  
    68  !!! note
    69      If the UI is not working, check the logs from `make start-local`. The logs are `DEBUG` level by default. If the logs are
    70      too noisy to find the problem, try editing log levels for the commands in the `Procfile` in the root of the Argo CD repo.
    71  
    72  ## Making Changes
    73  
    74  ### UI Changes
    75  
    76  Modifying the User-Interface (by editing .tsx or .scss files) auto-reloads the changes on port 4000.
    77  
    78  ### Backend Changes
    79  
    80  Modifying the API server, repo server, or a controller requires restarting the current `make start-local` session to reflect the changes.
    81  
    82  ### CLI Changes
    83  
    84  Modifying the CLI requires restarting the current `make start-local` session to reflect the changes.
    85  
    86  To test most CLI commands, you will need to log in.
    87  
    88  First, get the auto-generated secret:
    89  
    90  ```shell
    91  kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d; echo
    92  ```
    93  
    94  Then log in using that password and username `admin`:
    95  
    96  ```shell
    97  dist/argocd login localhost:8080
    98  ```
    99  
   100  ---
   101  Congrats on making it to the end of this runbook! 🚀
   102  
   103  For more on Argo CD, find us in Slack - <https://slack.cncf.io/> [#argo-contributors](https://cloud-native.slack.com/archives/C020XM04CUW)