Using Aloha Editor
After reading this guide, you will be able to:
- Prepare your development envireonment
- build your custom Aloha Editor
1 Clone from Github
You should know how to work with git before continuing.
First of all you have to get your copy of the Aloha Editor. Just clone our Github repository:
fork Aloha Editor before doing anything ;-)
git clone git@github.com:YOURNAME/Aloha-Editor.git alohaeditor cd alohaeditor git checkout dev
2 Repository Directory Structure
- /
- /bin – Build scripts
- /build – Build configuration
- /doc
- /doc/api – The API documentation
- /doc/guides – This document
- /vendor – Vendor source code. (e.g. ExtJS, require-js, jquery)
- /target – Build output folder
- /src
- /src/css – Aloha core css files
- /src/demo – Aloha demos
- /src/img – Aloha core images
- /src/lib – Require plugins and bootstrap files
- /src/lib/aloha – Main Aloha Editor core sources
- /src/lib/vendor – Vendor source code. E.g. ExtJS, jquery
- /src/lib/util – Utility sources. (e.g. json2.js, class.js)
- /src/plugins
- /src/plugins/common – Common plugin bundle
- /src/plugins/extra – Extra plugin bundle
- /src/test – QUnit tests
3 Building – Aloha Building
3.1 Debian Linux / Mac OS X
- Install nodejs See: http://nodejs.org
- Install npm See: http://npmjs.org
curl http://npmjs.org/install.sh | sh
- Install r.js
npm install -g requirejs@0.26.0 Note: Please use r.js 0.26.0 for now
Linux: Add r.js to your bin directory:
ln -s /root/node_modules/requirejs/bin/r.js /usr/local/bin/
Mac: r.js should be automatically added to your bin directory. Manual linking:
ln -s /Users/{username}/lib/node_modules/requirejs/bin/r.js /Users/{username}/bin/r.js
Manually from github
- Install jslint
cd /tmp npm install jslint mv /tmp/node_modules/jslint /usr/lib/node_modules/ ln -s /usr/lib/node_modules/jslint/bin/jslint.js jslint
- Invoke Building:
cd alohaeditor ./bin/build.sh build/aloha
3.2 Other OS:
- Microsoft Windows: Not yet supported
4 Guide
4.1 Installation
4.1.1 Debian Linux
apt-get install build-essential apt-get install ruby1.9.1-full cd /usr/bin ln -s ruby1.9.1 ruby ln -s gem1.9.1 gem gem install guides ln -s /var/lib/gems/1.9.1/gems/guides-0.7.1/bin/guides /usr/bin/guides guides preview
4.1.2 Mac OSX
gem install guides
4.1.3 Microsoft Windows
4.2 Using the Guides
- Preview Guides:
cd alohaeditor/doc/guides guides preview
Preview URL: http://localhost:9292/
- Building Guides:
guides build
5 Changelog
- October 11, 2011: Added building information
- July 3, 2011: Initial version by Sebastian Kurfürst and Christopher Hlubek