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