Skip to content
This repository has been archived by the owner. It is now read-only.
Front-end Boilerplate
Branch: master
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.
assets
views
.editorconfig
.gitignore
.postcss.json
.stylelintrc
README.md
data.json
package.json
rollup.config.js

README.md

Cercyon

Cercyon is a front-end boilerplate.

Requirements

This project requires Node 5.x.x or higher & npm 3.x.x (installer found here or use brew install node). This project uses NPM scripts you don't need any global depencies for this work, but I've found it's helpful to have them on your machine:

npm install -g browser-sync rollup standard watch rimraf svgo babel-cli imagemin-cli hbs-cli postcss-cli stylelint

Highlights

Cercyon doesn't have anything too special in it, just a common setup that's has my personal favorite defaults.

  • Handlebars: This project uses Handlebars templates as a static HTML generator. And it uses some sample data that should you should customize to your needs.
  • PostCSS: To process the CSS this project uses PostCSS with a few choice plugins: cssnext, postcss-import, postcss-apply. Plus it imports my Obsidian.css project.
  • Babel: To bundle the JavaScript this project uses Browserify and transpiles it with Babel (Presets: ES2015).
  • Linters: Stylelint for CSS and Standard.js for JS, there's nothing too nuts in there. It's included in the build process but it'd be cool to setup it up in your editor of choice (Syntastic for Vim & Linter for Atom).

Metalsmith

There's a Metalsmith version of this called project Hephaestus.

License

MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.