Slush Tangerine

Front-End boilerplate generator with tangerine flavor.

How to use install and use the generator?

Install the slush:

$ [sudo] npm install -g slush

Install the tangerine generator:

$ [sudo] npm install -g slush-tangerine

Use the generator:

$ slush tangerine

The generated boilerplate

Basic docs:

• Getting Started

Stack based in NodeJS:

• Generator: Slush
• Task Runner: Gulp
• HTML Template Engine: Pug
• CSS Post Processor: PostCSS
• JS Traspiler: BabelJS
• Test Runner: Karma
• Test Framework: Jasmine

• "Browser" for test: PhantomJS

Vendors:

• CSS Reset: Normalize

Folders Structure:

.
├── README.md
├── out/
├── tests/
├── src/
|   ├── assets/
|   ├── includes/
|   ├── partials/
|   ├── layouts/
|   └── index.jade
├── config.json
├── gulpfile.js
├── package.json
├── karma.conf.js
├── .editorconfig
├── .jshintrc
└── .gitignore

Automatic Tasks:

• $ gulp build: Compile, concat and minify all files.
• $ gulp serve: Watch the files to build and start a static server.
• $ gulp deploy: Deploy for gh-pages.
• $ gulp validate: Code quality (JS Hint).
• $ karma start: Launch a Phantomjs and watch for unit tests.

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our roadmap the next steps of the project ;) Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © Afonso Pacifer