Skip to content

Commit

Permalink
docs: add prerequisites
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielMSchmidt committed May 1, 2021
1 parent e39f5e5 commit ca4afbc
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Contributing

To build and install `terraform-cdk` locally, Node version 12.16+
To build and install `terraform-cdk` locally you need to install:

- Node version 12.16+
- Go 1.16+
- dotnet (v3.1.0)
- mvn
- pipenv

Alternatively you can work on the CDK from within a docker container with the image `docker.mirror.hashicorp.services/hashicorp/jsii-terraform`, e.g.:

```shell
$ docker run -it --rm -w=/home -v (pwd):/home docker.mirror.hashicorp.services/hashicorp/jsii-terraform
```

or through [Visual Studio Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers).

## Getting Started

Expand Down

0 comments on commit ca4afbc

Please sign in to comment.