2017-09-11 22:05:01 +02:00
|
|
|
# Pulumi Fabric Node.js SDK
|
|
|
|
|
|
|
|
The Pulumi Fabric Node.js SDK lets you write cloud programs in JavaScript.
|
|
|
|
|
|
|
|
## Installing
|
|
|
|
|
|
|
|
For now, we only support developers building from source. Eventually we will have a nice installer.
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
|
|
To build and install the SDK, you will first need a few things.
|
|
|
|
|
|
|
|
First, install Node.js 6.10.2. We recommend [nvm](https://github.com/creationix/nvm), since it makes it easier
|
|
|
|
to switch between versions of Node.js. Afterwards, run `nvm install 6.10.2`.
|
|
|
|
|
|
|
|
Next, we suggest using [Yarn](https://yarnpkg.com/lang/en/docs/install/) for package management. NPM works too, but
|
|
|
|
Yarn is faster and therefore preferred. Please follow the directions on Yarn's website.
|
|
|
|
|
|
|
|
### Building and Testing
|
|
|
|
|
2017-09-12 00:17:11 +02:00
|
|
|
The first time you build, you must `make configure` to install and prepare native plugins for V8:
|
|
|
|
|
|
|
|
$ make configure
|
|
|
|
|
|
|
|
Make sure to run this after installing the right version of Node.js above, otherwise it may bind to the wrong version.
|
|
|
|
|
2017-09-11 22:05:01 +02:00
|
|
|
To build the SDK, simply run `make` from the root directory (`sdk/nodejs/`). This will build the code, run tests, and
|
|
|
|
then "install" the package (by `yarn link`ing the resulting `bin/` directory).
|
|
|
|
|
|
|
|
We recommend putting `bin/` on your `$PATH`, since the `pulumi-langhost-nodejs` executable will be loaded dynamically
|
2017-09-22 04:18:21 +02:00
|
|
|
by the `pulumi` tool whenever it encounters a Node.js program.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2017-09-22 04:18:21 +02:00
|
|
|
The tests will verify that everything works, but feel free to try running `pulumi plan` and/or `pulumi deploy` from
|
|
|
|
the `examples/minimal/` directory. Remember to run `tsc` first, since `pulumi` expects JavaScript, not TypeScript.
|
2017-09-11 22:05:01 +02:00
|
|
|
|