Skip to content

Commit 71310b1

Browse files
committed
fix: Missing install steps
1 parent 2751aa5 commit 71310b1

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,31 @@ Explore:
8686

8787
---
8888

89+
## Quickstart
90+
91+
**Run using Docker:**
92+
93+
docker run -e SPRING_PROFILES_ACTIVE=appliance-prod -e APP_CLIENT_URL=http://localhost:8080 -p 8080:8080 ghcr.io/invergent-ai/studio:latest
94+
95+
**Connect the studio to your Kubernetes cluster:**
96+
97+
1. Navigate to Admin section > Clusters and edit default cluster.
98+
2. Add the KubeConfig of your k8s cluster.
99+
100+
**Deploy the studio on your Kubernetes cluster (Optional):**
101+
102+
export KUBECONFIG=<kube config path>
103+
cd <PROJECT_ROOT>/src/main/helm
104+
105+
kubectl create namespace surogate
106+
helm install --namespace surogate surogate surogate
107+
108+
**Install dependencies:**
109+
110+
<PROJECT_ROOT>/install/install-deps.sh
111+
112+
---
113+
89114
## Development
90115

91116
Before you can build this project, you must install and configure the following dependencies on your machine:
@@ -134,15 +159,6 @@ then
134159

135160
npm run docker:push
136161

137-
If not already, install the application on a k8s cluster:
138-
139-
export KUBECONFIG=<kube config path>
140-
cd <PROJECT_ROOT>/src/main/helm
141-
142-
kubectl create namespace surogate
143-
helm install --namespace surogate surogate surogate
144-
145-
146162
---
147163

148164
## Contributing

0 commit comments

Comments
 (0)