https://github.com/abernier/heroku-buildpack-nodejs

https://github.com/abernier/heroku-buildpack-nodejs

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/abernier/heroku-buildpack-nodejs
• Owner: abernier
• License: mit
• Fork: true (heroku/heroku-buildpack-nodejs)
• Created: 2012-10-09T13:03:55.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2012-10-09T13:34:25.000Z (about 12 years ago)
• Last Synced: 2023-03-12T02:39:41.952Z (almost 2 years ago)
• Language: Shell
• Homepage:
• Size: 7.77 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Heroku buildpack: Node.js

=========================

This is a [Heroku buildpack](http://devcenter.heroku.com/articles/buildpacks) for Node.js apps.

It uses [NPM](http://npmjs.org/) and [SCons](http://www.scons.org/).

Usage

-----

Example usage:

    $ ls

    Procfile  package.json  web.js

    $ heroku create --stack cedar --buildpack http://github.com/heroku/heroku-buildpack-nodejs.git

    $ git push heroku master

    ...

    -----> Heroku receiving push

    -----> Fetching custom buildpack

    -----> Node.js app detected

    -----> Vendoring node 0.4.7

    -----> Installing dependencies with npm 1.0.8

           [email protected] ./node_modules/express

           ├── [email protected]

           ├── [email protected]

           └── [email protected]

           Dependencies installed

The buildpack will detect your app as Node.js if it has the file `package.json` in the root.  It will use NPM to install your dependencies, and vendors a version of the Node.js runtime into your slug.  The `node_modules` directory will be cached between builds to allow for faster NPM install time.

Node.js and npm versions

------------------------

You can specify the versions of Node.js and npm your application requires using `package.json`

    {

      "name": "myapp",

      "version": "0.0.1",

      "engines": {

        "node": ">=0.4.7 <0.7.0",

        "npm": ">=1.0.0"

      }

    }

To list the available versions of Node.js and npm, see these manifests:

http://heroku-buildpack-nodejs.s3.amazonaws.com/manifest.nodejs

http://heroku-buildpack-nodejs.s3.amazonaws.com/manifest.npm

Hacking

-------

To use this buildpack, fork it on Github.  Push up changes to your fork, then create a test app with `--buildpack ` and push to it.

To change the vendored binaries for Node.js, NPM, and SCons, use the helper scripts in the `support/` subdirectory.  You'll need an S3-enabled AWS account and a bucket to store your binaries in.

For example, you can change the default version of Node.js to v0.6.7.

First you'll need to build a Heroku-compatible version of Node.js:

    $ export AWS_ID=xxx AWS_SECRET=yyy S3_BUCKET=zzz

    $ s3 create $S3_BUCKET

    $ support/package_nodejs 0.6.7

Open `bin/compile` in your editor, and change the following lines:

    DEFAULT_NODE_VERSION="0.6.7"

    S3_BUCKET=zzz

Commit and push the changes to your buildpack to your Github fork, then push your sample app to Heroku to test.  You should see:

    -----> Vendoring node 0.6.7