Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 2 KB

README.md

File metadata and controls

77 lines (46 loc) · 2 KB
Raw

Cloud Foundry Node.js Buildpack

CF Slack Join us on Slack

A Cloud Foundry buildpack for Node based apps.

This is based on the Heroku buildpack.

Additional documentation can be found at the CloudFoundry.org.

Buildpack User Documentation

Official buildpack documentation can be found at node buildpack docs.

Building the Buildpack

  1. Install buildpack-packager
(cd src/staticfile/vendor/github.com/cloudfoundry/libbuildpack/packager/buildpack-packager && go install)
  1. Build the buildpack
buildpack-packager [ --cached | --uncached ]
  1. 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. Install ginkgo
(cd src/nodejs/vendor/github.com/onsi/ginkgo/ginkgo && go install)
  1. Run unit tests
./scripts/unit.sh
  1. Run integration tests
./scripts/integration.sh

More information can be found on github cutlass.

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