Cloud Foundry Node.js Buildpack

Join us on Slack

A Cloud Foundry buildpack for Node based apps.

Buildpack User Documentation

Official buildpack documentation can be found at node buildpack docs.

Building the Buildpack

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

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

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

1. Install buildpack-packager

   bash go install github.com/cloudfoundry/libbuildpack/packager/buildpack-packager@master

2. Build the buildpack

   bash buildpack-packager build -stack [STACK] [ --cached=(true|false) ]

3. Use in Cloud Foundry

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

```bash
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.

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

1. Run unit tests

   bash ./scripts/unit.sh

2. 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:

```bash
cf login -a https://api.your-cf.com -u name@example.com -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:

```bash
./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.

Acknowledgements

Inspired by the Heroku buildpack.