nwayo

/nwajo/ (haitian creole) The tough central part of various fruits, containing the seeds.

What is nwayo ?

• A completely hackable and extendable front end boilerplate
• A multi-theme, multi-site, multi-CMS front end framework
• A back end agnostic environment

Requirements - Installation guide

• Node.js (nwayo CLI)

Get started

Run in your project root folder

# Get boilerplate
npx @absolunet/nwayo-grow-project

# Install workflow and vendor (in nwayo root folder)
npm install

# Install CLI
npm install -g @absolunet/nwayo-cli

# Build (in nwayo root folder)
nwayo rebuild

Tools  

nwayo is HTML5 ready and uses gulp as a build system

• Based (but not mandatory) on Zurb Foundation
• Uses npm as dependencies manager and EditorConfig for consistency

Styling

• CSS3 ready via Autoprefixer and linted via stylelint
• Comes with Sass, built via Dart Sass
• Minifies with cssnano

Scripting

• ES6+ ready via Babel and linted via ESLint
• Comes with jQuery, Modernizr, Lodash, pinki, JsRender, kafe
• Builds with gulp-include and is minified with UglifyJS

Other

• Optimizes images via gifsicle, MozJPEG, optipng, svgo
• Generates iconography via Jimp, to-ico

Tried and tested

Currently deployed on 200+ sites including:

• Drupal
• Wordpress
• Symfony
• Magento 1 & 2 (On Premise & Cloud)
• Sitecore
• Insite (On Premise & Cloud)
• Shopify

Extensions

Multiple extensions available

Packages

Package	Version	Description
@absolunet/nwayo-workflow		Workflow where all the magic happens
@absolunet/nwayo-toolbox		Toolbox with SCSS/JS helpers
@absolunet/nwayo-cli		CLI
@absolunet/nwayo-grow-project		Boilerplate generator for nwayo project
@absolunet/nwayo-grow-extension		Boilerplate generator for nwayo extension

Documentation

• Full documentation (source)     [in progress...]
• CodePen examples

Release history

See the releases.

Contributing

Issues | Pull requests

License

MIT © Absolunet