want to hear more about what we're up to, blanche yourself to the
public list **clockworks-announce**.
+## Getting started
+
+Clockworks is in pre-pre-alpha phase; most of the functionality hasn't been done yet.
+
+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. We also have a Hiveminder project with bite-sized tasks that you can work on (ping a project maintainer to get invited.)
+
+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**
+
+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**
+
+Now, to install the application. Assuming that you have a reasonable version of Python on your system, running **./nosudo-virtualenv.sh** should set up the environment. If it succeeds, you'll see the help output for a command named paster.
+
+Run the application by changing into your environment with **source tg2env/bin/activate** and then typing **paster serve --reload development.ini**. And voila; a very boilerplate TurboGears install should be facing you at http://localhost:8080
+
+If these steps fail (which happens on some configurations of OS X and almost invariably on Windows), talk to us and we can get you set up with a copy running on scripts.mit.edu or xvm.mit.edu.
+
+Once you're running, here are some paths to take:
+
+1. Take a break and read some TurboGears 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
+
+
## Development info
Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
### What to do?
-* [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding
* <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>
* <del>Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). (**ezyang**)</del>
* Learn SQLAlchemy (**ezyang**)
* <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>
* <del>Write a .gitignore file for generated/not versionable items</del>
* <del>Get friendly URLs working</del>
-* Learn Genshi (The new TurboGear default templating interface for 1.1+)
* <del>Setup a zephyrbot that watches the repository</del>
-* Learn [Widgets](http://docs.turbogears.org/1.0/Widgets) (we'll be using them for all of the forms in this website)
+* [Configure](http://turbogears.org/2.0/docs/main/Config.html) the default TurboGears scaffolding
+* Learn [Genshi](http://turbogears.org/2.0/docs/main/Genshi.html), the templating engine
+* Learn [Widgets](http://turbogears.org/2.0/docs/main/ToscaWidgets/forms.html) (we'll be using them for all of the forms in this website)
* Polish up and get SSL authentication working with TurboGears Identity (the two should be integrated together in a sane manner.)
* Write model classes for all of our tables
* Write controllers for each of the pages
List of "screens" in Doodle
-* **/**: Home page
+* **/**: Home page (including login)
* **/help**: Help pages (screencasts, interactive JavaScript, etc.)
* **/new**: Schedule event (should be one-page-able)
* General info (title, description, name, email)
* **/events/*event-name*/admin/history**: History
* **/events/*event-name*/admin/reset**: Delete all participants/comments
* **/events/*event-name*/admin/delete**: Delete poll
+* **/signup**: Signup page
+* **/myclockworks**: List of polls created by user, list of polls the user has participated in, links to creating a new event
+ * **/myclockworks/account** provides links to the following four links
+ * **/myclockworks/changeEmail**
+ * **/myclockworks/changePassword**
+ * **/myclockworks/editInformation**
+ * **/myclockworks/delete**
+ * Note: Doodle functions by creating two links per event: one for the public and one for administrator, but anyone can follow either link if they know what it is
## Phase 2
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
* Paul Weaver
* Xavid Pretzer
* Christian Ternus
+* David Benjamin
* <a href="mailto:clockworks@mit.edu">You?</a>
sipb-www / wiki.git / blobdiff