History

CyrusNajmabadi 6135a41643 Restore previous marshalling logic for Ids. (#852 )		2018-01-29 13:29:45 -08:00
..
asset	Many asset improvements	2017-10-22 13:39:21 -07:00
bin	Adopt new makefile system	2017-11-16 23:56:29 -08:00
cmd	Further simplification of resource RPC requests. (#840 )	2018-01-25 15:26:39 -08:00
dynamic	Implement resource protection (#751 )	2017-12-20 14:31:07 -08:00
log	Make root resources more general	2017-11-26 12:01:13 -08:00
runtime	Restore previous marshalling logic for Ids. (#852 )	2018-01-29 13:29:45 -08:00
tests	Extract out serialization functionality from transfer function. (#835 )	2018-01-25 13:34:21 -08:00
.gitignore	Build, integration tests and publishing on Windows	2017-10-02 13:40:58 -07:00
config.ts	Fix outdated config error message	2017-11-17 08:53:58 -08:00
errors.ts	Improve output formatting	2017-09-23 05:20:11 -07:00
index.ts	Add a manifest to checkpoint files (#630 )	2017-12-01 13:50:32 -08:00
Makefile	Add a manifest to checkpoint files (#630 )	2017-12-01 13:50:32 -08:00
metadata.ts	Add (back) component outputs	2017-11-20 17:38:09 -08:00
package.json	Return all computed inputs from Provider.Check.	2017-12-03 09:33:16 -08:00
pulumi-langhost-nodejs	Adopt new makefile system	2017-11-16 23:56:29 -08:00
pulumi-provider-pulumi-nodejs	Adopt new makefile system	2017-11-16 23:56:29 -08:00
README.md	`push` is dead; long live `update`.	2017-09-22 17:23:40 -07:00
resource.ts	wrap long comments. (#842 )	2018-01-25 18:50:58 -08:00
tsconfig.json	Add a manifest to checkpoint files (#630 )	2017-12-01 13:50:32 -08:00
tslint.json	Enable tslinting of the nodejs sdk. (#433 )	2017-10-18 15:03:56 -07:00
version.ts	Add a manifest to checkpoint files (#630 )	2017-12-01 13:50:32 -08:00
yarn.lock	Return all computed inputs from Provider.Check.	2017-12-03 09:33:16 -08:00

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.

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.