added readme info

This commit is contained in:
mik-tf 2024-09-06 15:08:35 -04:00
parent 8baeacd5c3
commit 826bc45292

View File

@ -29,10 +29,6 @@ This is a proof-of-concept of a basic Dashboard UI in Python using FastApi and H
## Download Repo
```
git clone https://git.ourworld.tf/tfgrid/ui_poc
cd ui_poc
```
## Prerequisites
@ -44,11 +40,15 @@ You can simply clone the repo and run the make command:
### Local
Run locally on your machine.
```
make run
```
- Download the repo
```
git clone https://git.ourworld.tf/tfgrid/ui_poc
cd ui_poc
```
- Run locally on your machine.
```
make run
```
This runs the `./scripts/microvm.sh` script.
@ -56,9 +56,16 @@ This runs the `./scripts/microvm.sh` script.
Run on a TFGrid micro VM with IPv4 address. Make sure to point a DNS A record of your (sub)domain to the IPv4 address of the VM
```
make microvm domain="example.com"
```
- From a fresh micro VM
```
apt update && apt install -y git
git clone https://git.ourworld.tf/tfgrid/ui_poc
cd ui_poc
```
- Run on the micro VM
```
make microvm domain="example.com"
```
This runs the `./scripts/microvm.sh` script.