fix typo
[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 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 * 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)
27 * Write a .gitignore file for generated/not versionable items
28 * Get friendly URLs working
29 * Learn TurboGear's templating interface (ezyang would like XSLT, but I don't think anyone else will let him use that)
30
31 ### Architecture
32
33 * Python and Turbogears
34 * Git repository
35 * Use 15 minute timeslices to simplify interface (?)
36
37 ### Principles
38
39 * Simplicity
40 * Extendibility
41 * Open Source
42
43 ### Schema
44
45 To be transferred from the whiteboard
46
47 ### Page Inventory
48
49 List of "screens" in Doodle
50
51 * Home page
52 * Help pages (screencasts, interactive JavaScript, etc.)
53 * Schedule event (should be one-page-able)
54   * General info (title, description, name, email)
55   * Days (calendar, should be AJAX)
56   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
57   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
58   * Poll created (admin, participant links)
59 * View poll (timezone, name, times, information, functions)
60   * Edit entry (completely wiki!)
61   * Delete entry
62   * Add a comment
63   * Calendar export (both ways)
64   * File export (excel, pdf)
65   * Subscribe (atom, and then social feed services)
66   * Embed poll (iframe)
67 * Admin poll (participation link)
68   * Edit poll (all original options)
69   * History
70   * Delete all participants/comments
71   * Delete poll
72
73 ## Phase 2
74
75 Doodle killer. Extra features. Pump it up.
76
77 * Integration
78   * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
79   * Advanced: integration with MIT's course schedules, Facebook
80   * Would store persistent profiles of calendar data for users
81 * Automatically prioritize and schedule events for you
82 * Create mobile phone friendly version
83
84 ## Developers
85
86 * Geoffrey Thomas
87 * Paul Baranay
88 * Edward Yang
89 * Paul Weaver
90 * <a href="mailto:clockworks@mit.edu">You?</a>