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 ## Development info
  12
  13 Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
  14
  15 ## Phase 1
  16
  17 Doodle clone. 100% duplication of Doodle functionality. Modifications to improve usability as necessary.
  18
  19 What do people not like about Doodle?
  20
  21 * Too much clicking
  22 * No obvious "I can, but would rather not"
  23
  24 ### What to do?
  25
  26 * [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding
  27 * Work through the [TurboGears tutorial](http://docs.turbogears.org/1.0/Wiki20/Page1) (the tutorial seems to focus on SQLObject, which is not necessarily the best thing. Maybe someone can find some better docs?)
  28 * Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). Also, make sure SQLAlchemy is being used
  29 * Learn SQLAlchemy
  30 * <del>Make sure the default scaffolding works on Scripts (this includes running TurboGears as CGI). Any work done here should be considered for a TurboGears auto-installer, the equivalent of tgsetup) (**ezyang**)</del>
  31 * <del>Write a .gitignore file for generated/not versionable items</del>
  32 * Get friendly URLs working
  33 * Learn TurboGear's templating interface (would like XSLT, but I don't think anyone else will like that)
  34 * <del>Setup a zephyrbot that watches the repository</del>
  35
  36 ### Architecture
  37
  38 * Python and Turbogears
  39 * Git repository
  40 * Use 15 minute timeslices to simplify interface (?)
  41 * AJAX (?)
  42
  43 ### Principles
  44
  45 * Simplicity
  46 * Extendibility
  47 * Open Source
  48
  49 ### Schema
  50
  51 To be transferred from the whiteboard
  52
  53 ### Page Inventory
  54
  55 List of "screens" in Doodle
  56
  57 * **/**: Home page
  58 * **/help**: Help pages (screencasts, interactive JavaScript, etc.)
  59 * **/new**: Schedule event (should be one-page-able)
  60   * General info (title, description, name, email)
  61   * Days (calendar, should be AJAX)
  62   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
  63   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
  64   * Poll created (admin, participant links)
  65 * **/events/*event-name***: View poll (timezone, name, times, information, functions)
  66   * **/events/*event-name*/edit**: Edit entry (completely wiki!)
  67   * Delete entry
  68   * **/events/*event-name*/comment**: Add a comment
  69   * **/events/*event-name*/export**: Calendar export (both ways)
  70   * File export (excel, pdf)
  71   * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services)
  72   * **/events/*event-name*/embed**: Embed poll (iframe)
  73 * **/events/*event-name*/admin**: Admin poll (participation link)
  74   * **/events/*event-name*/admin/edit**: Edit poll (all original options)
  75   * **/events/*event-name*/admin/history**: History
  76   * **/events/*event-name*/admin/reset**: Delete all participants/comments
  77   * **/events/*event-name*/admin/delete**: Delete poll
  78
  79 ## Phase 2
  80
  81 Doodle killer. Extra features. Pump it up.
  82
  83 * Integration
  84   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
  85   * Advanced: integration with MIT's course schedules, Facebook
  86   * Would store persistent profiles of calendar data for users
  87 * Automatically prioritize and schedule events for you
  88 * Create mobile phone friendly version
  89
  90 ## Developers
  91
  92 * Geoffrey Thomas
  93 * Paul Baranay
  94 * Edward Yang
  95 * Paul Weaver
  96 * Xavid Pretzer
  97 * Christian Ternus
  98 * <a href="mailto:clockworks@mit.edu">You?</a>