Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 2.95 KB

README.md

File metadata and controls

54 lines (43 loc) · 2.95 KB

maracuyá-jukebox Build Status

Maracuyá is a javascript based virutal mp3 player that lets you control your playlist from a browser. It support all major browsers including: IE, Safari, Firefox, Chrome and different operating systems: Windows, Linux, Mac OS

Read more on http://maracuya-jukebox.com

This is a JavaScript-everywhere project:

Project Library used
server-side nodejs
client-side browser
mobile phonegap
standalone node-webkit
build-system grunt

Building

Prequisites

Build system uses grunt project and node-pre-gyp so first you need to install the two:

npm install -g grunt-cli [email protected] 

If you want to be able to build mobile clients yourself you're also going to need phonegap package:

npm install -g [email protected]

NOTE: phonegap is in older version due to this bug

Dependencies

After you have required global modules you can start with installation by issuing:

npm install

This should download all dependencies as well as precompbiled binary modules using node-pre-gyp. Support for most popular platforms is out-of-the box but not all so you can build native modules on your own using node-gyp or contact me to provide binary for your platform :)

Commands

Maracuyá jukebox is javascript-everywhere project, so there's variety of build commands which produce different results and have some configuration options (all of them need to be issued from maracuya-jukebox/maracuya directory):

Command Description Options
default Invokes jshint and builds performs static code analysis
build:mobile Builds maracuyá jukebox mobile client (JavaScript client layer, no phonegap yet) --env (production/dev) [dev] --mobiles (ios,android) [android]
build:web Builds maracuyá jukebox headless/server (might be part of debian build)
build:demo Builds demo application
release:mobile Builds and signs mobile application, currently android only.
release:standalone:win Builds maracuyá jukebox standalone using node-webkit