open-index/open-npm huggingface dataset:
npm package: @hmcts/dev-env
Description: A development environment for HMCTS
Latest version: 0.0.31

# CFT Dev Environment

This package will use Helm to deploy a development environment based on the Preview chart. It will automatically create a mirrord.json configuration to connect your local application to the deployed environment.

## Prerequisites

- [Helm](https://helm.sh/docs/intro/install/)
- [AZ CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [Node.js](https://nodejs.org/en/download/)

## Usage

```bash
npx @hmcts/dev-env
```

Run the command from your project root directory. The script will check for a Helm chart and Jenkinsfile.

To use a specific Preview template, run:

```bash 
#e.g. npx @hmcts/dev-env --template charts/app/values.custom.template.yaml
npx @hmcts/dev-env --template <template> 
```

To clean up the environment, run:

```bash
npx @hmcts/dev-env --delete
```

## Troubleshooting

If you encounter an issue fetching the Helm dependencies, you may need to re-add the hmctspublic repository.

```bash
helm repo remove hmctspublic
helm repo add hmctspublic https://hmctspublic.azurecr.io/helm/v1/repo/
```

For help, message #rse-dev-tools on Slack.