projects/clockworks.mdwn

   1 [[!meta title="Clockworks"]]
   2
   3 Hey guys, I heard there was this app called [Doodle](http://www.doodle.com/main.html). It's closed source. Let's make an open-source Doodle killer and call it Clockworks!
   4
   5 We have a mailing list - if you're interested in helping design the
   6 app, just [let one of the developers know](mailto:clockworks@mit.edu)
   7 and we'll add you to our mailing list, **clockworks**. Or if you just
   8 want to hear more about what we're up to, blanche yourself to the
   9 public list **clockworks-announce**.
  10
  11 ## Getting started
  12
  13 Clockworks is in alpha phase; the most basic functions of the system are operational.
  14
  15 The best way to get started with Clockworks is to get yourself added to the project, grab a copy of the code, get it running on your laptop, and then poke around the source code.
  16
  17 First, make sure you have Git installed on your system. You can grab it [here](http://git-scm.com/download). Verify that it installed by popping open a terminal and running **git --version**
  18
  19 Next, grab the source code.  If you have Debathena installed on your machine, you can clone the source using **git clone /mit/clockworks/clockworks.git**.  If not, you can use a dialup to get to the directory; **git clone ssh://username@linerva.mit.edu/mit/clockworks/clockworks.git** works well. If the clone succeeds, you will now have a folder named "clockworks".  **cd clockworks**
  20
  21 Now, to install the application according to the instructions in the repository.
  22
  23 Once you're running, here are some paths to take:
  24
  25 1. Take a break and read some Django documentation to get a feel for the framework
  26 2. Browse through the todo list, pick a task that seems interesting, and start working on figuring out how to make it work
  27 3. Browse the source, fiddle with some variables, see what changes
  28 4. Decide what clockworks should look like, and take off
  29
  30
  31 ## Development info
  32
  33 Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
  34
  35
  36 ### Principles
  37
  38 * Simplicity
  39 * Extendibility
  40 * Open Source
  41
  42 ## Potential Future Goals
  43
  44 Doodle killer. Extra features. Pump it up.
  45
  46 * Better UI
  47 * Integration
  48   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
  49   * Advanced: integration with MIT's course schedules, Facebook
  50   * Would store persistent profiles of calendar data for users
  51 * Automatically prioritize and schedule events for you
  52 * Create mobile phone friendly version
  53 * View of a single calendar month should show "ghosts" of days from immediately previous and immediately past months, to fill out all the weeks.
  54 * Ability to convert Yes/No polls into Yes/Maybe/No polls (and vice versa)
  55 * When setting up a new poll, ability to copy-paste the times for any arbitrary row into any number of other arbitrary rows
  56 * "Generic week" function
  57   * Indicates that the response is for a weekly meeting, not a specific date.
  58
  59 ## Developers
  60
  61 * Geoffrey Thomas
  62 * Paul Baranay
  63 * Edward Yang
  64 * Paul Weaver
  65 * Xavid Pretzer
  66 * Christian Ternus
  67 * David Benjamin
  68 * Paul W. Quimby
  69 * Andrew Farrell
  70 * <a href="mailto:clockworks@mit.edu">You?</a>
  71
  72