History

CyrusNajmabadi c544accfa6 Only attempt to serialize the properties of an object that are actually used. (#1000 )		2018-03-07 21:10:12 -08:00
..
asset
cmd	Produce better error messages when the main module is not found (#976 )	2018-02-26 10:54:56 -08:00
dist	Add custom NODE_PATH to resource cmd	2018-02-19 18:45:12 -08:00
dynamic	Make many fixes to closure serialization (#944 )	2018-03-01 00:32:01 -08:00
log
proto	Implement more of the Python runtime	2018-02-24 08:58:34 -08:00
runtime	Only attempt to serialize the properties of an object that are actually used. (#1000 )	2018-03-07 21:10:12 -08:00
scripts	Ship `nativeruntime.node` as part of the SDK	2018-02-16 18:12:33 -08:00
tests	Only attempt to serialize the properties of an object that are actually used. (#1000 )	2018-03-07 21:10:12 -08:00
.gitignore	Implement more of the Python runtime	2018-02-24 08:58:34 -08:00
config.ts	Improve failure messages (#932 )	2018-02-14 09:55:02 -08:00
errors.ts
index.ts
Makefile	Make many fixes to closure serialization (#944 )	2018-03-01 00:32:01 -08:00
metadata.ts
package.json	Rename pulumi package to @pulumi/pulumi (#917 )	2018-02-12 13:13:13 -08:00
README.md	Update the README	2018-02-14 10:33:18 -08:00
resource.ts
tsconfig.json	Fix filename in Node.js SDK tsconfig (#1001 )	2018-03-05 18:29:38 -08:00
tslint.json
version.ts
yarn.lock

README.md

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, since it makes it easier to switch between versions of Node.js. Afterwards, run nvm install 6.10.2. As part of the build, a custom build of Node.js 6.10.2 will be downloaded and installed alongside the SDK. This Node binary is identical to Node.js 6.10.2, except that it has one extra builtin module containing code that is used by the SDK to serialize JavaScript closures. The custom binary is built from this repo.

Next, we suggest using Yarn for package management. NPM works too, but Yarn is faster and therefore preferred. Please follow the directions on Yarn's website.

Building and Testing

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.

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 linking the resulting bin/ directory).

We recommend putting bin/ on your $PATH, since the pulumi-langhost-nodejs executable will be loaded dynamically by the pulumi tool whenever it encounters a Node.js program.

The tests will verify that everything works, but feel free to try running pulumi preview and/or pulumi update from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.