Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: dev setup instructions with tilt and nix #5186

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,29 @@ Currently successfully brings up charts - no guarantee that everything is workin

## Dependencies

- k3d
- terraform
- kubectl
### Docker
* choose the install method for your system https://docs.docker.com/desktop/

### Nix package manager
* recommended install method using https://github.com/DeterminateSystems/nix-installer
```
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
```

### direnv >= 2.30.0
* recommended install method from https://direnv.net/docs/installation.html:
```
curl -sfL https://direnv.net/install.sh | bash
echo "eval \"\$(direnv hook bash)\"" >> ~/.bashrc
source ~/.bashrc
```

## Regtest
* run in the `dev` folder:
```
direnv allow
make create-cluster
make init
make deploy-services
make deploy
tilt up
```

### Test
Expand Down Expand Up @@ -66,17 +77,6 @@ Currently successfully brings up charts - no guarantee that everything is workin
```
2. open http://localhost:3001

## Signet

* run in the `dev` folder:
```
direnv allow
make create-cluster
make init
make deploy-signet-services
make deploy-signet
```

## RTL access
-
```
Expand Down
Loading