beez-foundation

About beez-foundation

スマートフォン向けブラウザアプリ開発を迅速に開発・リリースするためのローカルWebサーバーです。

beez-foundationの特徴

beez-foundationの主な特徴は以下のような特徴を持っています。

JSONをローカルに置いておくだけでRESTfulなAPIを提供

beez-foundationにはモックサーバの機能が内蔵されているので、APIの実装を待たずに開発が進められます。

JSONやObjectを返すJavaScriptファイルを記述するだけで、それらをモックデータとして使用しRESTful APIを提供することができます。

もうサーバの実装を待ってフロントの開発が止まる…ということはありません。

静的配信サーバ機能

beez-foundationでは、beezでの開発効率を上げるためにプレコンパイルが必要なファイルを自動でコンパイルしてブラウザではコンパイル後のファイルを使用して画面の確認ができるように設計されています。

• ローカルディレクトリパスを設定しておくだけで、ローカルのファイル/ディレクトリにHTTP経由でアクセスできます。
  • Mac OS付属の「Web 共有」と同等以上の機能を提供します。
• handlebars (拡張子 : .hbs)を同一フォルダで precompile (拡張子 : .hbsc.js) に自動変換します。
  • 拡張子を .hbsにするだけでコンパイルを意識せずに利用することができます。
• stylus (拡張子 : .styl)を stylesheet (拡張子 : .css) に自動変換します。
  • 拡張子を .stylにするだけでコンパイルを意識せずに利用することができます。

一度設定ファイルを記述すれば、あとはシームレスにCSSプリプロセッサやテンプレートエンジンを使うことができます。

Install

$ npm install beez-foundation -g
$ beez-foundation -h

  Usage: beez-foundation [options]

  Options:

    -h, --help            output usage information
    -V, --version         output the version number
    -c --config <path>    server config path(format: json)
    -s --standalone       default configuration mode
    -d --debug            debug mode.
    -a --addmods <value>  I want to add a "/ m" module. It is more than one can be specified, separated by commas. format) -a dirname:absdirpath:from,... example) -a hoge:/tmp/hoge:

Getting started

Wiki : QuickStart

$ cd {Web共有したいディレクトリパス}
$ beez-foundation -s

## Mode: [Stand-alone]

##
## Start
## 		Beez Foundation Servers!!
##
##
## 	Mock Server [ off ]
##
## 	Express server listening on port:1109
## 		Static Server start [ success ]
## 		compress: [on]
## 		Please try to access. 
## 			http://0.0.0.0:1109
##

open browser: http://0.0.0.0:1109

ブラウザからのオペレーション

一度 beez-foundation が立ち上がれば、ブラウザから以下のような操作が簡単にできるので開発効率が上がります。

• ファイル/ディレクトリをブラウザから表示・操作することが可能です。
• ビルド・デプロイなどのコマンドオペレーションをブラウザから操作することが可能です。
• モックデータをブラウザ上から確認する事が可能です。

beez との連携

beezと連携することを前提として開発されています。

詳しくは github : beez を参照ください。

Requirements

beez-foundationが依存しているライブラリは以下になります。

• node.js
• beezlib
• bootstrap
• bytes
• colors
• commander
• handlebars
• hbs
• moment
• pause
• send
• RequireJS
• Stylus
• nib
• Underscore.js
• express
• mocha
• should
• plato
• jshint
• jsdoc3
• suns.js
• Zepto.js
• jsonminify

Versionについては、package.json を参照く���さい。一部はフロントのライブラリになります。

Contributing

• Kei FUNAGAYAMA - @fkei github
• Kazuma MISHIMAGI - @maginemu github
• HIRAKI Satoru - github
• Yuhei Aihara - github

Copyright

CyberAgent, Inc. All rights reserved.

LICENSE

@see : LICENSE

The MIT License (MIT)

Copyright © CyberAgent, Inc. All Rights Reserved.

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.