X-Git-Url: https://sipb.mit.edu/gitweb.cgi/wiki.git/blobdiff_plain/4dee1080af5783162be97b6b702edc1a2629264e..e22afa910ccb00ade650b5c81417ac1afd573658:/projects/clockworks.mdwn?ds=sidebyside diff --git a/projects/clockworks.mdwn b/projects/clockworks.mdwn index ac35557..ca7ccf6 100644 --- a/projects/clockworks.mdwn +++ b/projects/clockworks.mdwn @@ -8,49 +8,30 @@ and we'll add you to our mailing list, **clockworks**. Or if you just want to hear more about what we're up to, blanche yourself to the public list **clockworks-announce**. -## Development info - -Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git +## Getting started -## Phase 1 +Clockworks is in alpha phase; the most basic functions of the system are operational. -Doodle clone. 100% duplication of Doodle functionality. Modifications to improve usability as necessary. +The best way to get started with Clockworks is to get yourself added to the project, grab a copy of the code, get it running on your laptop, and then poke around the source code. -### Pitfalls to avoid +First, make sure you have Git installed on your system. You can grab it [here](http://git-scm.com/download). Verify that it installed by popping open a terminal and running **git --version** -What do people not like about Doodle? +Next, grab the source code. If you have Debathena installed on your machine, you can clone the source using **git clone /mit/clockworks/clockworks.git**. If not, you can use a dialup to get to the directory; **git clone ssh://username@linerva.mit.edu/mit/clockworks/clockworks.git** works well. If the clone succeeds, you will now have a folder named "clockworks". **cd clockworks** -* Too much clicking - * 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. -* No obvious "I can, but would rather not" - * Alleviated also by the above; this might want to be the default poll setup. +Now, to install the application according to the instructions in the repository. -### What to do? +Once you're running, here are some paths to take: -* [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding -* 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?) -* Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). Also, make sure SQLAlchemy is being used -* Learn SQLAlchemy -* 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**) -* Write a .gitignore file for generated/not versionable items -* Get friendly URLs working -* Learn Kid (TurboGear's default templating interface) -* Setup a zephyrbot that watches the repository -* Learn [Widgets](http://docs.turbogears.org/1.0/Widgets) (we'll be using them for all of the forms in this website) -* Polish up and get SSL authentication working with TurboGears identity +1. Take a break and read some Django documentation to get a feel for the framework +2. Browse through the todo list, pick a task that seems interesting, and start working on figuring out how to make it work +3. Browse the source, fiddle with some variables, see what changes +4. Decide what clockworks should look like, and take off -### Architecture -* **Language**: Python -* **Framework**: TurboGears -* **SCM**: Git -* **JavaScript**: Mochikit -* **Database**: SQLite for development, ? for production -* **ORM**: SQLAlchemy +## Development info -Other ideas: +Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git -* Use 15 minute timeslices to simplify interface ### Principles @@ -58,46 +39,22 @@ Other ideas: * Extendibility * Open Source -### Schema - -To be transferred from the whiteboard - -### Page Inventory - -List of "screens" in Doodle - -* **/**: Home page -* **/help**: Help pages (screencasts, interactive JavaScript, etc.) -* **/new**: Schedule event (should be one-page-able) - * General info (title, description, name, email) - * Days (calendar, should be AJAX) - * Times (timezone (JS fill-in), add more timeslots, copypaste first row) - * Options (yes-no-ifneedbe, hidden poll, limit OKs) - * Poll created (admin, participant links) -* **/events/*event-name***: View poll (timezone, name, times, information, functions) - * **/events/*event-name*/edit**: Edit entry (completely wiki!) - * Delete entry - * **/events/*event-name*/comment**: Add a comment - * **/events/*event-name*/export**: Calendar export (both ways) - * File export (excel, pdf) - * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services) - * **/events/*event-name*/embed**: Embed poll (iframe) -* **/events/*event-name*/admin**: Admin poll (participation link) - * **/events/*event-name*/admin/edit**: Edit poll (all original options) - * **/events/*event-name*/admin/history**: History - * **/events/*event-name*/admin/reset**: Delete all participants/comments - * **/events/*event-name*/admin/delete**: Delete poll - -## Phase 2 +## Potential Future Goals Doodle killer. Extra features. Pump it up. +* Better UI * Integration * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty) * Advanced: integration with MIT's course schedules, Facebook * Would store persistent profiles of calendar data for users * Automatically prioritize and schedule events for you * Create mobile phone friendly version +* View of a single calendar month should show "ghosts" of days from immediately previous and immediately past months, to fill out all the weeks. +* Ability to convert Yes/No polls into Yes/Maybe/No polls (and vice versa) +* When setting up a new poll, ability to copy-paste the times for any arbitrary row into any number of other arbitrary rows +* "Generic week" function + * Indicates that the response is for a weekly meeting, not a specific date. ## Developers @@ -107,4 +64,9 @@ Doodle killer. Extra features. Pump it up. * Paul Weaver * Xavid Pretzer * Christian Ternus +* David Benjamin +* Paul W. Quimby +* Andrew Farrell * You? + +