https://github.com/jshcrowthe/gulp-foreman

An easy way to get up and running with foreman in your project.
https://github.com/jshcrowthe/gulp-foreman

Last synced: about 1 month ago
JSON representation

An easy way to get up and running with foreman in your project.

• Host: GitHub
• URL: https://github.com/jshcrowthe/gulp-foreman
• Owner: jshcrowthe
• Created: 2015-05-29T20:16:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-22T16:39:46.000Z (almost 7 years ago)
• Last Synced: 2024-12-01T21:16:58.105Z (about 2 months ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
gulp-foreman

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

This is a small foreman runner built for use with `gulp` (although it can be used outside of gulp as well).

## Install

Install this plugin by running the following command at your terminal

```bash

npm i -S gulp-foreman

```

## Example Usage

The following are a different ways to use the plugin

### Default

Default usage is simple:

```javascript

var gulp = require('gulp');

var foreman = require('gulp-foreman');

gulp.task('default', function (argument) {

  foreman();

});

```

You can provide a `.env` file in the same dir as your `gulpfile.js` that will be used to configure the environment of your process.

### Configuration

You can also pass a configuration object with several params:

- **procfile**: You can pass a string to this to specify the procfile used.

- **env**: You can pass a string, or an array of strings, to define and configure the environment.

- **port**: You can pass a number to define the default port. _NOTE: If you pass this param it will supercede any value passed in a .ENV file_

**Procfile Config**

```javascript

var gulp = require('gulp');

var foreman = require('gulp-foreman');

gulp.task('default', function (argument) {

  foreman({

    procfile: 'Procfile.dev'

  });

});

```

**Env Config**

```javascript

var gulp = require('gulp');

var foreman = require('gulp-foreman');

gulp.task('default', function (argument) {

  foreman({

    env: 'beta.env',

    // You can also pass an array like below and all envs will be included

    // env: ['beta.env', 'beta_test.env'] 

  });

});

```

**Port Config**

```javascript

var gulp = require('gulp');

var foreman = require('gulp-foreman');

gulp.task('default', function (argument) {

  foreman({

    port: 80

  });

});

```

## License

MIT