Skip to content

uhray/boilerplate

Repository files navigation

Uhray Boilerplate

The Uhray Boilerplate is a starting point for web application development projects. It was originally inspired by html5-boilerplate, but we shifted the focus to creating dynamic web applications that needed more than the basics of an HTML5 site. We set out to build a collection of tech tools that would allow developers to easily and efficiently create modern web applications. We wanted to organize the codebase according to how we typically think about web applications (page-centric, complete separation of frontend and backend, etc). Lastly, we wanted to create a framework with complete transparency and no magic. This gives the developer complete flexibility to do virtually anything he/she desires, however he/she chooses, without being pigeonholed or restricted to the confines of typical development frameworks. The end result is the Uhray Boilerplate.

Features

  • Uses Require.js for frontend javascript organization.
  • Uses r.js for frontend optimization in production.
  • Hosted using expressjs, pre-configured with some middleware.
  • API ready to be built using crud.
  • Ready for mustache for the backend rendering.
  • Uses ractivejs for frontend view rendering.
  • Includes normalize.css for CSS normalizations and common bug fixes.
  • Built in (but removable) CSS element reset. (see main.scss).
  • Frontend JavaScript dependencies managed with bower.
  • Built ready for heroku deployment.
  • Easily extendable to new modules npm and bower.
  • Uses gulp build system.
  • Uses Sass/SCSS as CSS Extension library hosted with sourcemaps and Autoprefixer for easy css prefix handling.
  • Ready for mongodb connectivity via mongoosejs.
  • Linting with JSCS.

Quick Start

Dependencies:

git clone git@github.com:uhray/boilerplate.git
cd boilerplate
npm install
SECRET=thisSecret gulp dev
// Application is now running at http://localhost:5000

Documentation

Take a look at the Uhray Boilerplate Docs. This documentation is bundled with the project, which makes it readily available for offline viewing and provides a useful starting point for any documentation you want to write about your web application.

Browser Compatibility

This boilerplate should be compatible with all evergreen browsers.