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