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 ### Pitfalls to avoid
  20
  21 What do people not like about Doodle?
  22
  23 * Too much clicking
  24  * We can deal with this by collapsing the three-page wizard Doodle has into a single page. Be careful not to sacrifice too much simplicity for such a setup.
  25 * No obvious "I can, but would rather not"
  26  * Alleviated also by the above; this might want to be the default poll setup.
  27 * Trac, one of the first Python web applications to hit mainstream, was long bemoaned for being complex to install. Try not to have the same story
  28
  29 ### What to do?
  30
  31 * <del>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?)</del>
  32 * <del>Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). (**ezyang**)</del>
  33 * Learn SQLAlchemy (**ezyang**)
  34 * <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>
  35 * <del>Write a .gitignore file for generated/not versionable items</del>
  36 * <del>Get friendly URLs working</del>
  37 * <del>Setup a zephyrbot that watches the repository</del>
  38 * [Configure](http://turbogears.org/2.0/docs/main/Config.html) the default TurboGears scaffolding
  39 * Learn [Genshi](http://turbogears.org/2.0/docs/main/Genshi.html), the templating engine
  40 * Learn [Widgets](http://turbogears.org/2.0/docs/main/ToscaWidgets/forms.html) (we'll be using them for all of the forms in this website)
  41 * Polish up and get SSL authentication working with TurboGears Identity (the two should be integrated together in a sane manner.)
  42 * Write model classes for all of our tables
  43 * Write controllers for each of the pages
  44
  45 ### Architecture
  46
  47 * **Language**: Python 2.5+
  48 * **Framework**: TurboGears 2.0
  49 * **SCM**: Git
  50 * **JavaScript**: Mochikit
  51 * **Database**: SQLite for development, ? for production
  52 * **ORM**: SQLAlchemy
  53 * **Templating**: Genshi
  54
  55 Other ideas:
  56
  57 * Use 15 minute timeslices to simplify interface
  58
  59 ### Principles
  60
  61 * Simplicity
  62 * Extendibility
  63 * Open Source
  64
  65 ### Schema
  66
  67 You can view the database schema in *model.py*. Some notable features:
  68
  69 * All `user.user_id` foreign keys are paired with an `anon_name` field. If user_id is null, then the associated entity was posted by an anonymous user, and `anon_name` contains the name they submitted for themselves
  70 * The current `time_slots` table uses `DateTime` and `Interval` to define events. We should consider whether or not 15 minute timeslices will be the native representation in the database, or simply a simpler model for the interface
  71 * `length` is likely common through all possible times for an event, so it's stored in both `time_slots` and `event`
  72 * `events.timezone` represents the timezone that the event is occurring in, so we can give user-friendly times. If this field is null, then the creator's `user.timezone` field is used (if that is also null, we should probably use EST)
  73 * `key` and `admin_key` in `event` refer to random values that will compose the URLs for events.
  74 * For full backwards compatibility, `hidden` and `extended` are stored as boolean attributes (the former refers to hiding the responses of users, the latter refers to allowing Yes/No/IfNeedBe responses). We may want to consider an alternate model for these properties
  75 * The schema is not very generalized. Certain parts should definitely be generalized, but let's try to avoid the architecture astronaut syndrome.
  76
  77 ### Page Inventory
  78
  79 List of "screens" in Doodle
  80
  81 * **/**: Home page (including login)
  82 * **/help**: Help pages (screencasts, interactive JavaScript, etc.)
  83 * **/new**: Schedule event (should be one-page-able)
  84   * General info (title, description, name, email)
  85   * Days (calendar, should be AJAX)
  86   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
  87   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
  88   * Poll created (admin, participant links)
  89 * **/events/*event-name***: View poll (timezone, name, times, information, functions)
  90   * **/events/*event-name*/edit**: Edit entry (completely wiki!)
  91   * Delete entry
  92   * **/events/*event-name*/comment**: Add a comment
  93   * **/events/*event-name*/export**: Calendar export (both ways)
  94   * File export (excel, pdf)
  95   * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services)
  96   * **/events/*event-name*/embed**: Embed poll (iframe)
  97 * **/events/*event-name*/admin**: Admin poll (participation link)
  98   * **/events/*event-name*/admin/edit**: Edit poll (all original options)
  99   * **/events/*event-name*/admin/history**: History
 100   * **/events/*event-name*/admin/reset**: Delete all participants/comments
 101   * **/events/*event-name*/admin/delete**: Delete poll
 102 * **/signup**: Signup page
 103 * **/myclockworks**: List of polls created by user, list of polls the user has participated in, links to creating a new event
 104   * **/myclockworks/account** provides links to the following four links
 105   * **/myclockworks/changeEmail**
 106   * **/myclockworks/changePassword**
 107   * **/myclockworks/editInformation**
 108   * **/myclockworks/delete**
 109   * Note: Doodle functions by creating two links per event: one for the public and one for administrator, but anyone can follow either link if they know what it is
 110
 111 ## Phase 2
 112
 113 Doodle killer. Extra features. Pump it up.
 114
 115 * Better UI
 116 * Integration
 117   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
 118   * Advanced: integration with MIT's course schedules, Facebook
 119   * Would store persistent profiles of calendar data for users
 120 * Automatically prioritize and schedule events for you
 121 * Create mobile phone friendly version
 122 * View of a single calendar month should show "ghosts" of days from immediately previous and immediately past months, to fill out all the weeks.
 123 * Ability to convert Yes/No polls into Yes/Maybe/No polls (and vice versa)
 124 * When setting up a new poll, ability to copy-paste the times for any arbitrary row into any number of other arbitrary rows
 125 * "Generic week" function
 126   * Indicates that the response is for a weekly meeting, not a specific date.
 127
 128 ## Developers
 129
 130 * Geoffrey Thomas
 131 * Paul Baranay
 132 * Edward Yang
 133 * Paul Weaver
 134 * Xavid Pretzer
 135 * Christian Ternus
 136 * <a href="mailto:clockworks@mit.edu">You?</a>