98540180263010646928089d346c2f23f1c6bd70
[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 * Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). (**ezyang**)
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
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 * **Templating**: Genshi
51
52 Other ideas:
53
54 * Use 15 minute timeslices to simplify interface
55
56 ### Principles
57
58 * Simplicity
59 * Extendibility
60 * Open Source
61
62 ### Schema
63
64 To be transferred from the whiteboard
65
66 ### Page Inventory
67
68 List of "screens" in Doodle
69
70 * **/**: Home page
71 * **/help**: Help pages (screencasts, interactive JavaScript, etc.)
72 * **/new**: Schedule event (should be one-page-able)
73   * General info (title, description, name, email)
74   * Days (calendar, should be AJAX)
75   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
76   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
77   * Poll created (admin, participant links)
78 * **/events/*event-name***: View poll (timezone, name, times, information, functions)
79   * **/events/*event-name*/edit**: Edit entry (completely wiki!)
80   * Delete entry
81   * **/events/*event-name*/comment**: Add a comment
82   * **/events/*event-name*/export**: Calendar export (both ways)
83   * File export (excel, pdf)
84   * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services)
85   * **/events/*event-name*/embed**: Embed poll (iframe)
86 * **/events/*event-name*/admin**: Admin poll (participation link)
87   * **/events/*event-name*/admin/edit**: Edit poll (all original options)
88   * **/events/*event-name*/admin/history**: History
89   * **/events/*event-name*/admin/reset**: Delete all participants/comments
90   * **/events/*event-name*/admin/delete**: Delete poll
91
92 ## Phase 2
93
94 Doodle killer. Extra features. Pump it up.
95
96 * Integration
97   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
98   * Advanced: integration with MIT's course schedules, Facebook
99   * Would store persistent profiles of calendar data for users
100 * Automatically prioritize and schedule events for you
101 * Create mobile phone friendly version
102
103 ## Developers
104
105 * Geoffrey Thomas
106 * Paul Baranay
107 * Edward Yang
108 * Paul Weaver
109 * Xavid Pretzer
110 * Christian Ternus
111 * <a href="mailto:clockworks@mit.edu">You?</a>