Cloud Foundry buildpack for Node.js
Go JavaScript Shell
Pull request Compare This branch is 1 commit ahead, 223 commits behind cloudfoundry:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
fixtures
profile
scripts
src/nodejs
.envrc
.gitallowed
.gitignore
CHANGELOG
CONTRIBUTING.md
ISSUE_TEMPLATE
LICENSE
NOTICE
PULL_REQUEST_TEMPLATE
README.md
VERSION
manifest.yml

README.md

Cloud Foundry Node.js Buildpack

CF Slack 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 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 buildpack-packager

    (cd src/nodejs/vendor/github.com/cloudfoundry/libbuildpack/packager/buildpack-packager && go install)
  3. Build the buildpack

    buildpack-packager [ --cached | --uncached ]
  4. 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. Run unit tests

    ./scripts/unit.sh
  3. 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

Acknowledgements

Inspired by the Heroku buildpack.