07d901b45191e5549c4466adeb5dabf21dea2729
[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 app, or if you just want to hear more about what we're up to,  just blanche yourself onto **clockworks**.
6
7 ## Development info
8
9 Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
10
11 ## Phase 1
12
13 Doodle clone. 100% duplication of Doodle functionality. Modifications to improve usability as necessary.
14
15 What do people not like about Doodle?
16
17 * Too much clicking
18 * No obvious "I can, but would rather not"
19
20 ### What to do?
21
22 * [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding
23 * 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?)
24 * Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). Also, make sure SQLAlchemy is being used
25 * Learn SQLAlchemy
26 * <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>
27 * Write a .gitignore file for generated/not versionable items
28 * Get friendly URLs working
29 * Learn TurboGear's templating interface (would like XSLT, but I don't think anyone else will like that)
30 * <del>Setup a zephyrbot that watches the repository</del>
31
32 ### Architecture
33
34 * Python and Turbogears
35 * Git repository
36 * Use 15 minute timeslices to simplify interface (?)
37 * AJAX (?)
38
39 ### Principles
40
41 * Simplicity
42 * Extendibility
43 * Open Source
44
45 ### Schema
46
47 To be transferred from the whiteboard
48
49 ### Page Inventory
50
51 List of "screens" in Doodle
52
53 * Home page
54 * Help pages (screencasts, interactive JavaScript, etc.)
55 * Schedule event (should be one-page-able)
56   * General info (title, description, name, email)
57   * Days (calendar, should be AJAX)
58   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
59   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
60   * Poll created (admin, participant links)
61 * View poll (timezone, name, times, information, functions)
62   * Edit entry (completely wiki!)
63   * Delete entry
64   * Add a comment
65   * Calendar export (both ways)
66   * File export (excel, pdf)
67   * Subscribe (atom, and then social feed services)
68   * Embed poll (iframe)
69 * Admin poll (participation link)
70   * Edit poll (all original options)
71   * History
72   * Delete all participants/comments
73   * Delete poll
74
75 ## Phase 2
76
77 Doodle killer. Extra features. Pump it up.
78
79 * Integration
80   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
81   * Advanced: integration with MIT's course schedules, Facebook
82   * Would store persistent profiles of calendar data for users
83 * Automatically prioritize and schedule events for you
84 * Create mobile phone friendly version
85
86 ## Developers
87
88 * Geoffrey Thomas
89 * Paul Baranay
90 * Edward Yang
91 * Paul Weaver
92 * <a href="mailto:clockworks@mit.edu">You?</a>