node package manager

generator-brightspot-silhouette

generator-brightspot-silhouette

Brightspot Silhouette is a project scaffolding tool geared toward front-end web development. At the start of your Brightspot project, it's meant to get you up and running quickly by automating the inclusion of a standard front-end toolchain, a standard structure of directories and a baseline of conventions.

Here's what you can expect Silhouette to scaffold and install:

  • README.md
  • .editorconfig
  • .gitignore
  • .jshintrc
  • favicon.ico
  • package.json
  • ES6 and System.js support
  • jspm
  • A Javascript application bootstrap
  • An example Javascript module
  • the following directory structure under:
src/main/webapp
   |-assets
   |---fonts
   |---images
   |---js
   |-----components
   |---styles
   |-----components

Installing

First, you'll need to download and build a copy of Brightspot You can follow the quick install instructions if you'd like. At this time, they are the following:

mvn archetype:generate -B \
    -DarchetypeRepository=http://public.psddev.com/maven \
    -DarchetypeGroupId=com.psddev \
    -DarchetypeArtifactId=cms-app-archetype \
    -DarchetypeVersion=3.0-SNAPSHOT \
    -DgroupId=com.project.foo \
    -DartifactId=fooProject

Since Silhouette is a Yeoman generator, you'll need to install Yeoman and then install the Silhouette generator.

$ npm install -g yo
$ npm install -g generator-brightspot-silhouette

Running

At the root of your Brightspot project, run the following command:

$ yo brightspot-silhouette <<YOUR_APP_NAME>>

Roadmap

  • CSS pre-processor scaffolds
    • Less
    • Sass
  • Build scaffolds
    • grunt
    • gulp

License

MIT