slush-webhook

Generator for Webhook projects.

Usage no npm install needed!

<script type="module">
  import slushWebhook from 'https://cdn.skypack.dev/slush-webhook';
</script>

README

slush-webhook npm release

This generator is the starting point for a Webhook-based website. It contains all the modules, boilerplate, and built-in process to get you started building and deploying a full website.

Created by Ronik Design and used to speed up internal development.

Features

  • Scaffold Webhook projects.
  • Deploy staging sites easily to S3 (requires a properly configured AWS account. The easiest approach here is probably brew install awscli then aws configure)
  • Choose from one of three frameworks, all using ES6 and webpack
    • Starter Kit — uses Knockout.js, a robust set of SCSS and PostCSS tools, and more
    • Bootstrap — installs Bootstrap and all its dependencies, in a friendly hackable way
    • Blank — just the process setup, and a few polyfills.
  • Automatic SVG sprite generation.
  • Image optimization.
  • Gulp-based build tools.

Getting started

Install your global dependencies.

$ npm install -g slush slush-webhook

Webhook installation

$ npm install -g wh grunt-cli

If this is a totally new Webhook project, create your Webhook site, then run:

$ wh create [sitename]
$ cd [sitename]
$ slush webhook

Warning! Slush uses conflict resolution and allows you to reject overwriting files, BUT you could very easily overwrite something you care about as it spews a bunch of files and folders into your current directory and merges with your package.json. Be careful, try it out first on something you don't care about, commit or backup first. But also, feel free to run it again and again.

Working with your site

You'll find documentation within the newly-created site's README that offers more detail, but the basics are as follows.

Develop your site, watching files for changes and updating on the fly:

gulp develop

This launches Gulp watchers and the Webhook local dev server. The browser will reload when the html, css or js changes.

Deploy your site to Webhook:

gulp deploy --target=production

Or, deploy it to a staging S3 bucket (if configured):

gulp deploy --target=staging --production

This will deploy the site to an S3 bucket with a name derived from your staging_url if it exists, otherwise, from your url.

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.