Use Resources to quickly build your single page web application, native web app or whatever you like to call it. Resources is built with NodeJS, ExpressJS, AmpersandJS, Waterline, Webpack.

git clone --depth=1 https://github.com/brianberlin/boilerplate.git myproject
cd myproject
git remote rm origin
npm i
npm start

Resources.json is where you can declare your application resources in JSON format. Below is what is currently configurable in Resources.json.

• name [string] resource name
• model [object]:
  • slug [string]: used as lookup id for the resource
  • props [object]:
    • type [string]: can be string, text, integer, float, date, time, datetime, boolean, binary, array, or json
    • model [string]: to reference another resource
    • inputElement [string]: html element type to used in view: currently can only be input or textarea
    • inputElementAttributes [string]: html input attributes to attach to the inputElement
    • other attributes can be found in waterline documentation
  • populate [string]: to automatically populate references in the default route handler
• routes [object]: Where you define the resource routes. The default route code can be overridden by creating a file with the same name as the resource and by exporting a function with the name of the method and path all together in camelcase. Eg. { method: 'get', path: 'user/:slug/reset' } => exports.getUserSlugReset
  • method [string]: get, post, put, delete (the put post is duplicated with a patch method)
  • path [string]: the slug parameter is used in the default route handlers.
  • protect [boolean]: protect route against non-authenticated users.
  • description [string]: for convenience and is displayed in development in the console.
• view [object]: This property is used to build the client views. The client view files are created when the application is started. If you don't want client views generated you can leave this property undefined. When views are generated, a checksum is created which allows the server to detect manual changes to the files in the view folder so they don't get overwritten.
  • titleField [string]: Used to specify the field to be used as the title of the resource
  • teaserFields [string]: Used to specify the fields to be displayed as the teaser
  • detailFields [string]: Used to specify the fields to be used on detail view

Favicons, which is a NodeJs favicons generator, is configured with an executable script in lib. Execute it with the path of your PNG and it will create favicon assets of all different sizes as well as the markup for the various platforms.