https://github.com/ripeworks/web-build

Build tooling for web projects
https://github.com/ripeworks/web-build

Last synced: 11 months ago
JSON representation

Build tooling for web projects

• Host: GitHub
• URL: https://github.com/ripeworks/web-build
• Owner: ripeworks
• License: mit
• Created: 2015-01-19T14:50:32.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-07-10T19:25:38.000Z (over 10 years ago)
• Last Synced: 2025-02-05T18:03:02.841Z (about 1 year ago)
• Language: JavaScript
• Size: 254 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Gulp tooling for web projects

Configurable gulp tooling with sane conventions.

Includes the following:

* browserify + watchify

* browserSync

* coffeescript

* stylus

* sourcemaps

* production builds

* custom server

## Usage

* `npm install --save-dev web-build gulp`

* Create a gulpfile for your project

* Configure and require:

```js

var gulp = require('gulp')

var options = {

  scripts: ['app/app.js', 'server/server.js'],

  styles: {

    src: ['styles/application.styl'],

    watch: 'styles'

  },

  server: {

    path: 'server/server.js',

    port: 3001,

    timeout: 2000,

    extensions: ['js', 'jade'],

    watch: ['server']

  }

}

require('web-build')(gulp, options)

```

* Use gulp (`gulp watch`, `gulp build`)

## Options

| option | description | default |

|--------|-------------|---------|

| scripts | Array of scripts to build. | `[]` |

| styles  | Object including `src` array of stylesheets to build and an optional `watch` directory to watch for changes. | `{}` |

| server | Object including `path` string to server script, `port` to listen on, `watch` array of directories to watch for changes. _Port must be different from main port option because a proxy is used with BrowserSync._ | `false` |

| port | Port to listen on. | `3000` |

| paths | Object including `dest` string to build destination, `scripts` string to scripts destination, `styles` string to stylesheets destination. | `{dest: 'public', scripts: 'js', styles: 'css'}` |

## Roadmap

* ES6 support