oils

oils

Oils JS

Oils is a web framework built on top of Express framework. It's very flexible and very simple to use, you'll love it!

It is primarily used to create Openshift Node JS Applications. You can also use this for other projects as the variable dependencies are just very few and are all in the configuration file.

It will automatically read models and controllers. Also features automatic routing for created controllers.

Directory Structure:

|-- controllers
|-- models
|-- views
|-- public
|-- lib

You can see the README.md's of each directory above for more information.

Set-Up

For OpenShift apps, after creating your node js + mongodb application, clone the project to your local and go to that directory.

Example:

> npm install oils -g

> oils new HelloWorld

> cd HelloWorld

> npm install

> node server.js

or you can just simply Download the zip version of this project and copy-paste it to your node js application.

Usage

This sample app is self explanatory. Just browse through the directories and files and you will get the hang of it.

It uses Mongoose for ORM. Mongo DB for the database. Swig for templating.

Contact

If you have questions, feel free to drop me an email: [e-mail]

License

The MIT License (MIT)

Copyright (c) 2014 Manny

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.