add clockworks
[wiki.git] / 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 * <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 * Learn Genshi (The new TurboGear default templating interface for 1.1+)
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 (the two should be integrated together in a sane manner.)
41 * Write model classes for all of our tables
42 * Write controllers for each of the pages
43
44 ### Architecture
45
46 * **Language**: Python
47 * **Framework**: TurboGears
48 * **SCM**: Git
49 * **JavaScript**: Mochikit
50 * **Database**: SQLite for development, ? for production
51 * **ORM**: SQLAlchemy
52 * **Templating**: Genshi
53
54 Other ideas:
55
56 * Use 15 minute timeslices to simplify interface
57
58 ### Principles
59
60 * Simplicity
61 * Extendibility
62 * Open Source
63
64 ### Schema
65
66 You can view the database schema in *model.py*. Some notable features:
67
68 * 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
69 * 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
70 * `length` is likely common through all possible times for an event, so it's stored in both `time_slots` and `event`
71 * `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)
72 * `key` and `admin_key` in `event` refer to random values that will compose the URLs for events.
73 * 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
74 * The schema is not very generalized. Certain parts should definitely be generalized, but let's try to avoid the architecture astronaut syndrome.
75
76 ### Page Inventory
77
78 List of "screens" in Doodle
79
80 * **/**: Home page
81 * **/help**: Help pages (screencasts, interactive JavaScript, etc.)
82 * **/new**: Schedule event (should be one-page-able)
83   * General info (title, description, name, email)
84   * Days (calendar, should be AJAX)
85   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
86   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
87   * Poll created (admin, participant links)
88 * **/events/*event-name***: View poll (timezone, name, times, information, functions)
89   * **/events/*event-name*/edit**: Edit entry (completely wiki!)
90   * Delete entry
91   * **/events/*event-name*/comment**: Add a comment
92   * **/events/*event-name*/export**: Calendar export (both ways)
93   * File export (excel, pdf)
94   * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services)
95   * **/events/*event-name*/embed**: Embed poll (iframe)
96 * **/events/*event-name*/admin**: Admin poll (participation link)
97   * **/events/*event-name*/admin/edit**: Edit poll (all original options)
98   * **/events/*event-name*/admin/history**: History
99   * **/events/*event-name*/admin/reset**: Delete all participants/comments
100   * **/events/*event-name*/admin/delete**: Delete poll
101
102 ## Phase 2
103
104 Doodle killer. Extra features. Pump it up.
105
106 * Integration
107   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
108   * Advanced: integration with MIT's course schedules, Facebook
109   * Would store persistent profiles of calendar data for users
110 * Automatically prioritize and schedule events for you
111 * Create mobile phone friendly version
112
113 ## Developers
114
115 * Geoffrey Thomas
116 * Paul Baranay
117 * Edward Yang
118 * Paul Weaver
119 * Xavid Pretzer
120 * Christian Ternus
121 * <a href="mailto:clockworks@mit.edu">You?</a>