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
  28 ### What to do?
  29
  30 * [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding
  31 * 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?)
  32 * Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). Also, make sure SQLAlchemy is being used
  33 * Learn SQLAlchemy
  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 * Get friendly URLs working
  37 * Learn Kid (TurboGear's default templating interface)
  38 * <del>Setup a zephyrbot that watches the repository</del>
  39 * Learn [Widgets](http://docs.turbogears.org/1.0/Widgets) (we'll be using them for all of the forms in this website)
  40 * Polish up and get SSL authentication working with TurboGears identity
  41
  42 ### Architecture
  43
  44 * **Language**: Python
  45 * **Framework**: TurboGears
  46 * **SCM**: Git
  47 * **JavaScript**: Mochikit
  48 * **Database**: SQLite for development, ? for production
  49 * **ORM**: SQLAlchemy
  50
  51 Other ideas:
  52
  53 * Use 15 minute timeslices to simplify interface
  54
  55 ### Principles
  56
  57 * Simplicity
  58 * Extendibility
  59 * Open Source
  60
  61 ### Schema
  62
  63 To be transferred from the whiteboard
  64
  65 ### Page Inventory
  66
  67 List of "screens" in Doodle
  68
  69 * **/**: Home page
  70 * **/help**: Help pages (screencasts, interactive JavaScript, etc.)
  71 * **/new**: Schedule event (should be one-page-able)
  72   * General info (title, description, name, email)
  73   * Days (calendar, should be AJAX)
  74   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
  75   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
  76   * Poll created (admin, participant links)
  77 * **/events/*event-name***: View poll (timezone, name, times, information, functions)
  78   * **/events/*event-name*/edit**: Edit entry (completely wiki!)
  79   * Delete entry
  80   * **/events/*event-name*/comment**: Add a comment
  81   * **/events/*event-name*/export**: Calendar export (both ways)
  82   * File export (excel, pdf)
  83   * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services)
  84   * **/events/*event-name*/embed**: Embed poll (iframe)
  85 * **/events/*event-name*/admin**: Admin poll (participation link)
  86   * **/events/*event-name*/admin/edit**: Edit poll (all original options)
  87   * **/events/*event-name*/admin/history**: History
  88   * **/events/*event-name*/admin/reset**: Delete all participants/comments
  89   * **/events/*event-name*/admin/delete**: Delete poll
  90
  91 ## Phase 2
  92
  93 Doodle killer. Extra features. Pump it up.
  94
  95 * Integration
  96   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
  97   * Advanced: integration with MIT's course schedules, Facebook
  98   * Would store persistent profiles of calendar data for users
  99 * Automatically prioritize and schedule events for you
 100 * Create mobile phone friendly version
 101
 102 ## Developers
 103
 104 * Geoffrey Thomas
 105 * Paul Baranay
 106 * Edward Yang
 107 * Paul Weaver
 108 * Xavid Pretzer
 109 * Christian Ternus
 110 * <a href="mailto:clockworks@mit.edu">You?</a>