Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudfoundry/nodejs-buildpack
Cloud Foundry buildpack for Node.js
https://github.com/cloudfoundry/nodejs-buildpack
v2b
Last synced: 1 day ago
JSON representation
Cloud Foundry buildpack for Node.js
- Host: GitHub
- URL: https://github.com/cloudfoundry/nodejs-buildpack
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2013-03-12T16:57:19.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T03:47:13.000Z (10 days ago)
- Last Synced: 2024-11-07T04:25:54.426Z (10 days ago)
- Topics: v2b
- Language: Go
- Homepage: http://docs.cloudfoundry.org/buildpacks/
- Size: 87.4 MB
- Stars: 171
- Watchers: 98
- Forks: 385
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ibmcloud - nodejs-buildpack - Cloud Foundry buildpack for Node.js. (Platform)
README
# Cloud Foundry Node.js Buildpack
[ Join us on Slack](https://cloudfoundry.slack.com/messages/buildpacks/)
A Cloud Foundry [buildpack](http://docs.cloudfoundry.org/buildpacks/) for Node based apps.
### Buildpack User Documentation
Official buildpack documentation can be found at [node buildpack docs](http://docs.cloudfoundry.org/buildpacks/node/index.html).
### 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](https://direnv.net/) which will automatically source .envrc when you change directories.
1. Install buildpack-packager
```bash
go install github.com/cloudfoundry/libbuildpack/packager/buildpack-packager@master
```
1. Build the buildpack
```bash
buildpack-packager build -stack [STACK] [ --cached=(true|false) ]
```
1. 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](https://github.com/cloudfoundry/libbuildpack/tree/master/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](https://direnv.net/) which will automatically source .envrc when you change directories.
1. Run unit tests
```bash
./scripts/unit.sh
```
1. Run integration tests
Buildpacks use the [Cutlass](https://github.com/cloudfoundry/libbuildpack/tree/master/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](https://github.com/cloudfoundry/cli):
```bash
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:
```bash
./scripts/integration.sh
```
### Contributing
Find our guidelines [here](./CONTRIBUTING.md).
### Help and Support
Join the #buildpacks channel in our [Slack community](http://slack.cloudfoundry.org/).
### Reporting Issues
Open an issue on this project.
### Active Development
The project backlog is on [Pivotal Tracker](https://www.pivotaltracker.com/projects/1042066).
### Acknowledgements
Inspired by the [Heroku buildpack](https://github.com/heroku/heroku-buildpack-nodejs).