balihoo / balihoo-creative

Balihoo Web Designer Toolkit

Balihoo Web Designer Toolkit

balihoo-creative allows web and interactive designers to build customizable templates on their own workstation, using their favorite editors and compile tools. It integrates with Balihoo's online resources like Form-Builder & BLIP to make template design and maintenance a seemless, painless experience.

Version

0.5.1

Installation

Make sure you have a recent version of node and npm installed and then run:

sudo npm -g install balihoo-creative

If npm is installed as root then you may have to run it using sudo.

Updating

To update to the most recent version run:

sudo npm -g update balihoo-creative

Usage

The app contains its own extensive documentation and tutorial. To view the docs and tutorial: first, install the app, create an empty directory, run the app with --new within that directory, then run the app without parameters.

mkdir /tmp/project
cd /tmp/project
balihoo-creative --new
balihoo-creative

Running the app with --new in an empty directory will generate the tutorial project in that directory. Running without parameters will run the web server, and open your browser to the Getting Started tutorial page.

Contribute

To contribute to this project you will want to run locally with the in-development codebase rather than the published package. If you have the published package installed globally you'll want to uninstall it.

sudo npm -g uninstall balihoo-creative

To begin making changes to this tool, first fork it on github. Then, clone your fork to your workstation.

git clone https://github.com/balihoo/balihoo-creative.git
cd balihoo-creative

Then, run npm install and link the binary to your development copy.

npm install
npm link

This project is built using coffeescript that is transpiled to javascript. Make sure that you have coffeescript installed globally.

npm install -g coffee-script

While developing you should run the following from the root of your project. This will watch the source files and compile them as they change.

coffee -o lib/ -cw src/

License

The MIT License (MIT)

Copyright (c) 2014 Balihoo, Inc.

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.

balihoo-creative's Issues

ReferenceError in local copy

I'm getting an error when trying to run a locally built copy, I'm using for development.

/Users/aharl/Development/balihoo-creative/lib/console.js:61
      } : options;
          ^
ReferenceError: options is not defined
  at new Console (/Users/aharl/Development/balihoo-creative/lib/console.js:61:11)
  at new module.exports (/Users/aharl/Development/balihoo-creative/lib/console.js:282:12)
  at Object.start (/Users/aharl/Development/balihoo-creative/lib/server.js:42:42)
  at Object.<anonymous> (/Users/aharl/Development/balihoo-creative/lib/index.js:17:14)
  at Object.<anonymous> (/Users/aharl/Development/balihoo-creative/lib/index.js:19:4)
  at Module._compile (module.js:456:26)
  at Object.Module._extensions..js (module.js:474:10)
  at Module.load (module.js:356:32)
  at Function.Module._load (module.js:312:12)
  at Module.require (module.js:364:17)
  at require (module.js:380:17)
  at Object.<anonymous> (/Users/aharl/Development/balihoo-creative/index.js:3:1)
  at Module._compile (module.js:456:26)
  at Object.Module._extensions..js (module.js:474:10)
  at Module.load (module.js:356:32)
  at Function.Module._load (module.js:312:12)
  at Function.Module.runMain (module.js:497:10)
  at startup (node.js:119:16)
  at node.js:902:3

This looks like it maps to line 25 in 'src/console.coffee'. Are there steps to build and install this besides make init, make build, and npm link?

Server not loading page on start

The console doesn't appear to work with the latest stable version of Node.

It actually appears that the server is not launching the template index page on start. The server appears to work normally if you manually put http://localhost:8088 in your browser.

I was mistakenly trying to use #console based on a screenshot in the tutorial documentation to load the console.