A Slush generator for web components.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
hello-component
node_modules
README.md
package.json
screenshot.png
slushfile.js

README.md

slush-component

A Slush generator for web components.

Screenshot

Introduction

Web components should be simple. To that end, this generator creates the following files:

  • docker-compose.yml: A Docker Compose file that defines an instance of the component-workshop.
  • index.js: The component implementation.
  • package.json: The NPM metadata and dependencies.
  • README.md: Something for your users to read by candlelight in the bath.
  • spec.js: Tests for the component.
  • test.js: A Jasmine test runner (invoked via npm test).

Getting Started

  1. Run the following command to install Homebrew:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  1. Using Homebrew, install NPM and Docker Toolbox:
brew install npm docker-toolbox
  1. Using NPM, install Slush and slush-component globally:
npm install -g slush slush-component
  1. Generate a component using the slush-component generator:
slush component
  1. Navigate to the directory of your web component (hello-component in this example):
cd hello-component
  1. Run the docker container container via docker-compose:
docker-compose up