Bespin Developer's Guide

Code Tour

Taking It From The Top

At the highest level, there are two separate projects that make up the whole of the Bespin codebase:

Most people hacking on Bespin will never need to do anything inside of the bespinserver project.

Inside bespinclient

In a fresh bespinclient checkout, there are four top-level directories of note:

When things are fully set up, there are also some other directories of interest:

There are a couple of directories that are not interesting:

Frameworks

Plugins

Bespin is built completely around plugins. The vast majority of the JavaScript for Bespin is in the plugins directory. In the plugins directory, there are three categories of plugins represented:

  1. supported - these are the plugins that are core bits of Bespin and that we are subjecting to increasingly rigorous demands in terms of documentation and testing.
  2. labs - these are more experimental parts of Bespin and we will be a bit less restrictive about what goes in here. The intention, however, is that things in the labs part of Bespin are likely to become part of supported someday.
  3. testing - these exist solely for the purpose of unit testing