https://github.com/dreamerslab/coke

A full stack MVC framework that speeds up your web development.
https://github.com/dreamerslab/coke

Last synced: about 2 months ago
JSON representation

A full stack MVC framework that speeds up your web development.

• Host: GitHub
• URL: https://github.com/dreamerslab/coke
• Owner: dreamerslab
• Created: 2012-01-18T14:45:35.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2015-02-25T08:53:06.000Z (over 9 years ago)
• Last Synced: 2024-04-13T22:12:40.319Z (5 months ago)
• Language: JavaScript
• Homepage: coke-js.org
• Size: 1.09 MB
• Stars: 120
• Watchers: 13
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        
# COKE

“ COKE is a full stack node.js MVC framework base on [Express](http://expressjs.com/).”

## Features

  - MVC structure.

  - [Mongoose](http://mongoosejs.com/) as ODM (mongodb), supports validation.

  - Lightening fast template parsing with [thunder](https://github.com/dreamerslab/thunder). It renders over a million pages within a second. However it can be replaced with any express compatible ones if it does not fit your need.

  - RESTful routing, supports namespace and nested resource. Thanks to [RailwayJS](http://railwayjs.com/).

  - Assets management (something like assets pipeline in Rails). COKE uses a YAML file to manage all the assets. You can group them, specify which assets to be used in the action view. On production they will be combined and minified with a version number at the end.

  - Middleware and 3rd party lib support, which means all the [express](http://expressjs.com/) and [connect](http://www.senchalabs.org/connect/) middlewares can be used directly.

  - Controller filters for flow control.

  - Comprehensive logger for debugging.

  - Powerful generators for project prototyping.

  - Model command line console.

  - Data migration tool.

  - Cluster support, gracefully shutdown all workers and the server.

  - Socket.io compatible.

## Requires

  - node >= 0.8.x

  - mongodb >= 2.X

  - packages

    - see packages.json

## Installation

  - Set up node.js development enviroment

      - [Mac](http://dreamerslab.com/blog/en/how-to-setup-a-node-js-development-environment-on-mac-osx-lion/)

      - [Ubuntu](http://dreamerslab.com/blog/en/how-to-setup-a-node-js-development-environment-on-ubuntu-11-04/)

      - [Windows](http://dreamerslab.com/blog/en/how-to-setup-a-node-js-development-environment-on-windows/)

  - Install through npm

    npm install coke -g

## Quick start

    $ coke new blog && cd blog

    $ npm install -l

    $ coke g scaffold posts title content is_public:bool

    # make sure your mongodb is on

    $ coke s

    $ open http://127.0.0.1:4000

## Todo

  - Add docs

  - Add tests

  - Add examples

## License

(The MIT License)

Copyright (c) 2012 dreamerslab <[email protected]>

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.