Dragonfly quickstart

Setting up development environment

Prerequesits: You will need python installed as well as mercurial.
  1. Install dragonkeeper. Hopefully you have easy_install or pip installed with your python installation. In that case you just need to call pip install dragonkeeper or easy_install dragonkeeper
  2. Get hold of the code by cloning the repository: hg clone https://bitbucket.org/scope/dragonfly-stp-1
  3. If you plan on submitting patches back to us you should create your own fork of the Dragonfly code instead of cloning the official repository. In order to do this, create a bitbucket accound and use the "fork" button on the project page.
  4. Run Dragonkeeper. You should be in checked out repostory when calling this: dragonkeeper
  5. Start an opera instance to debug. This should be a different version from the one you will run dragonfly inside. You can use the --pd argument to select a personal directory for opera. You can just use some temporary directory for this opera --pd /tmp/opera-debugee
  6. Connect to dragonkeeper in the debugee opera by opening opera:debug and clicking connect
  7. Open dragonfly in you normal opera installation. Navigate to http://localhost:8002/ . Then navigate to the file called client-en.xml. That file is the main dragonfly file.
  8. If you append "?debug" at the end of the dragonfly URL you will get a debug menu in Dragonfly that is useful for looking at message traffic and inspecting the markup that is used to construct dragonfly.

Some pointers about what happens where in the code

Getting fixes back into Dragonfly

  1. Edit the code and commit to your own fork
  2. Push back to bitbucket
  3. Create a pull request by clicking the pull request button on the project page.

When we receive the pull request the code will be reviewed. If there are issues that need to be fixed, we will ask you to update your fork. Once the fork passes review by two developers, it is pushed back to Dragonfly mainline. If you would like to be named in the list of contributors, either edit the AUTHORS file yourself as part of a commit, or give us your name so we can add it.