Appfolio JS app Yeoman generator

This template can be used directly for the creation of new JavaScript apps in APM.

Includes

• ES2015 using Webpack and Babel
• CSS with autoprefixing using PostCSS
• SCSS using sass-loader
• Development server and reloading using webpack-dev-middleware and webpack-hot-middleware
• Unit tests using Mocha and assert
• Headless browser tests using Mocha and Nightmare
• Linting using ESLint
• Code coverage using nyc

This generator is written in ES2015. This means it is not compatible with node.js versions before 4.0.

Installation

npm install -g yo
npm install -g generator-appfolio-js

Setting up projects

Create a new directory, and cd into it:

mkdir my-app
cd my-app

Run the generator

yo appfolio-js

and follow the prompts

Using

The sample code under /src is a basic vanilla JS example to ensure bundling works correctly. No UI or other frameworks have been included and need to be added by you.

Uses appfolio-js-template as the file and config template.

Setup

npm install

Develop

npm run

Open http://localhost:8080 in browser

• Uses hot-module-replacement to automatically rebuild and reload modules as the files under src are modified.

Test

npm test

• Runs unit tests using Mocha
• Runs headless browser tests using Mocha and Nightmare
• Shows code coverage using nyc/Istanbul. A coverage report will also be written in the ./coverage/ directory.

Lint

npm run lint

• Runs ESLint using airbnb-base as the base configuration

Contributors

• Gary Thomas
• Michael Jewell
• Li Zhang
• Aaron Panchal