isabella232 / nodejs-cnb

Cloud Foundry Node.js Buildpack v2

Join us on Slack

A Cloud Foundry buildpack for Node based apps, composed of Cloud Native Buildpacks.

Buildpack User Documentation

Official buildpack documentation can be found at node buildpack docs.

Building the Buildpack for Use in Cloud Foundry

To build this buildpack, run the following commands from the buildpack's directory:

1. Source the .envrc file in the buildpack directory.

   $ source .envrc

   To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

2. Install Go, if it is not already installed

   $ ./scripts/install_go.sh

3. Install the packaging tools

   $ ./scripts/install_shim_tools.sh

4. Build the buildpack, using cnb2cf

   $ cnb2cf package -stack <stack> [-cached] [-version <version>] [-cachedir <path to cachedir>]    

5. Use in Cloud Foundry

   Upload the buildpack to your Cloud Foundry and optionally specify it by name

   $ cf create-buildpack [BUILDPACK_NAME] [BUILDPACK_ZIP_FILE_PATH] 1
   $ cf push my_app [-b BUILDPACK_NAME]

Testing

Buildpacks use the Cutlass framework for running integration tests.

To test this buildpack, run the following command from the buildpack's directory:

1. Source the .envrc file in the buildpack directory.

   $ source .envrc

   To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

2. Install Go, if it is not already installed

   $ ./scripts/install_go.sh

3. Run integration tests

   Buildpacks use the Cutlass framework for running integration tests against Cloud Foundry. Before running the integration tests, you need to login to your Cloud Foundry using the cf cli:

   $ cf login -a https://api.your-cf.com -u [email protected] -p pa55woRD

   Note that your user requires permissions to run cf create-buildpack and cf update-buildpack.

   To run the integration tests, run the following command from the buildpack's directory:

   $ ./scripts/integration.sh

Contributing

Find our guidelines here.

Help and Support

Join the #buildpacks channel in our Slack community.

Reporting Issues

Open an issue on this project.

Active Development

The project backlog is on Pivotal Tracker.