01. Getting started

Getting started

Guidelines

If you like to work on Dizzy you should note a few things. They’re not really rules, but if everyone works that way it’s much easier to get something done (:

• Only work on the dev branch (where the rewritten code is). The master branch is older code that did not scale very well, and no new features should be added there.
• If you want to add a feature, please put it on the issue tracker so other people know it’s being worked on. It also allows for discussion about that particular feature.
• Modules should be written in AMD format, using require/define (see Writing modules for details). The “standard” module pattern (function(){}()) just doesn’t cut it for large applications.
• Wear pants while coding. Seriously.

Directory structure

Once you checked out the code you’ll see a directory structure like this:

dev/
  css/
  html/
  img/
  js/
    dizzy/
    libs/
    modules/
    other stuff...
  svg/
  other stuff..
  ...
make/
build.xml

The build.xml and the make dir can be used to concat and minimize the project files for deployment on a server (just run ant in the top level dir).
The dev directory contains all the code, HTML, css, images, etc.

The most interesting directory is probably dev/js/modules, that is where all the plugins go.
For more information about writing plugins/modules see Writing modules