The following libraries have been used:
- Node.js (for the webserver)
- Twitter Bootstrap (for quickly building the website)
- JSDoc (for code documentation)
And a couple more.
Clone the repository to your own computer:
git clone https://github.com/studioludens/musiqlab.git
and install the npm dependencies like so:
This will create a directory
Run the server
MUSIQLab uses (for the time being) only client-side libraries. That means you can run the code on any system of your choice, like Apache or any other HTTP server. If you have node installed, you can also use the bundled node-static server. Run it like this:
Documentation is created by JSDoc using a custom-made template (/jsdoc-template) and can be run by the following commandline utility:
Files are put in the ./public/docs/ folder.
Description of files
docs: generate documentation using the jsdoc compiler. It makes documentation only for the musiq.js library (./public/script/lib/musiq/)
gitcommit: shortcut for the git add, git commit and git push commands. Use a string with the commit message like ./gitcommit "message"
gitsubmup: update git submodules (for now only the musiqjs library)
heroku: deploy the app to heroku
Procfile: deployment instructions for heroku (see documentation )
server.js: the main node server application
License and Copyright
All code is (c)2013 Alexander Rulkens, but is free to use for commercial and non-commercial purposes. Basically you can do with it what you want, but please give me credit.