Development Setup

Prereq

1. Go 1.17
2. Go Fresh

   go install github.com/pilu/fresh
   

3. K3D (required for running locally)

Start

1. Run argo workflow in k3d

   scripts/argo.local.sh
   

   This will start a k3d cluster and deploy minimal Argo Workflow. It also port-forward 2746 to localhost

2. Modify cluster-admin file

   Patch the cluster-admin file by running the following command

    kubectl patch ClusterRoleBindings/cluster-admin --patch "$(cat cluster-admin-patch.yaml)"

3. Create and update .env file

   Copy .env.example file to .env file

   cp .env.example .env

   Then replace the contents of the .env with the following block:

   SERVER_PORT=3000
   ENV=development
   ARGO_TOKEN=eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk4dWFiYTF4ZU56SFA2OGFETWtwVXNlUGJhekdfV3B4NE9zYnpOVWZFZlkifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJhcmdvIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZWNyZXQubmFtZSI6ImFyZ28tc2VydmVyLXRva2VuLThzMmZkIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6ImFyZ28tc2VydmVyIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiNDRkMjZkYzUtM2JhNi00Nzc1LTk3NjgtYWMzYmI4ZDUwNjEwIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OmFyZ286YXJnby1zZXJ2ZXIifQ.nGIrVeWodcv3TdvP9A5FpAH1mjUUAzdVyiRB6zZ65Nd_qRsAgKMJaDoasIEaCTG3O1NqNH-L6EBmK4_wMkx5hCV4zgShkWyDwmQBGccL52-0g9r2EPzZUrK2djRoQFNBAVHhYdL8kcUpNxl-nKLBrLCNyinGnHRWblRmt021nZZsE62ljXj1TDmNRbg71oC94tnBeGi4j3Iza9KBf8cTjTeKYVyDLQrd6gGQuUpWZ9l4vfK7X4Ke8dDEuWtWkxDZgnNewQLZmPP7K-QUZEbNlL82r4KJSExaCJmBZfPx21QH0bSJbrl6Xr1m22W1OqTCEQEsNv2uIm7nV4A2vmhdZA
   ARGO_SERVER_URL=localhost:2746
   API_GATEWAY_URL=https://api-gw-service-nmn.local
   

4. Run server

   One time setup: copy and rename .env.example to .env

   scripts/runDev.sh
   

   Automatically rebuild and launch API server when a change is made. Fresh configuration file: {rootDir}/runner.conf

5. Load swagger and Argo

   These sites are on localhost and will only open with the previous scripts running

   • Swagger URL
   • Argo URL

Optional Steps

• Update swagger

  scripts/swagger.gen.sh
  

  Note: This script will try to update docs/swagger.md if nodejs is installed. Otherwise, it will only update docs/swagger.yaml

Reference

Dependency Injection

• uber fx

Clean gin template

Argo Workflow

K3D