jaggedsoft / stimpy-medium

Stimpy Medium

Stimpy is a simple yet inventive fellow, with a hint of refinement. This is a boilerplate for Hapi.js web or api apps. Stimpy is perfectly content to be run as a hapi plugin or a standalone server.

To install:

$ npm install -g stimpy supervisor bower gulp
$ stimpy create medium my-new-project
$ cd my-new-project

Start the server by running the command:

$ stimpy start

To add front-end packages (for example):

$ bower install --save d3

Point the git origin to something else eventually:

$ git remote set-url origin [email protected]:semateos/my-app.git

####Live test with heroku

$ git commit -am "awesome changes"
$ stimpy deploy heroku

See: https://devcenter.heroku.com/articles/getting-started-with-nodejs

####Production Build Before going into production you will want to concatenate and minify your assets.

To mini run:

$ gulp

Running gulp from the command line will run the tasks in the gulpfile.js. The current tasks will minify and optimize your CSS, JS, and Images. If you want more tasks you can go to the Gulp Plugin page. http://gratimax.github.io/search-gulp-plugins/

The Stack:

Node.js - Because it's fast, easy to get started, and Javscript is awesome. http://nodejs.org/

Supervisor - To watch for file changes and restart the server during development https://github.com/isaacs/node-supervisor.

Hapi - A very well designed server framework that is easy to understand, easy to create your own plugins, scales very well, cache options built in, and more. http://spumko.github.io/

Swig - It looks like HTML, it's very fast, great for template inheritance, and allows you to use HTML syntax with the server and with front-end client Javascript includes. http://paularmstrong.github.io/swig/

Bower - Package management for the front end. Bower uses a flat dependency tree, requiring only one version for each package, reducing page load to a minimum. http://bower.io/

CSS Framework - None. Choose your own CSS preprocessor and CSS framework.

Gulp - A task runner for your assets, and can do a lot more. The performance is amazing and it is easy to get started. http://gulpjs.com/ The main files of bower pacakges are automagically included in server/config/assets.js

Plugins

The Hapi plugins that are being used.

Dogwater

Dogwater makes Waterline ORM available as a Hapi plugin. Models exist in server/models and connection/adapter configurations live in server/config/dogwater.js. https://github.com/devinivy/dogwater

Hapi-Named-Routes

Added names to the routes. This allows you to have access to the path in the templates just by using the path.nameofroute variable. https://github.com/poeticninja/hapi-named-routes

Hapi-Assets

Assets are in the ./server/config/assets.js file, and your view layer has access based on the node environment. If you are in development (default) you might want to have individual files (js,css). If you are in production you would want the assets combined for user performance. https://github.com/poeticninja/hapi-assets

Hapi-Cache Buster

Client/browser reloads new assets based on package.json version of your application. https://github.com/poeticninja/hapi-cache-buster

Folder Structure

There are two main folders in the stack. The "public" folder for front-end (client side) code, and "server" folder for server side code. index.js defines the hapi plugin, server.js is a sample server using the plugin.

Contributers

Sam Mateosian

Based on hapi-ninja from Saul Maddox and, sample-hapi-rest-api

Credits

Credit goes to all of the open source code that people have made available.

License

The MIT 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.