JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
update wfpl and templates
[contractor-progress.git] / README
1 This project is a website for managing tasks between a freelance programmer and
2 their clients.
3
4 The code is available under the terms of the AGPL v3 and uses the wfpl library
5 which is under GPL v3.
6
7 Current features:
8
9         1) Password protection
10
11         2) Add client accounts
12
13         3) Enter and edit task descriptions
14
15         4) Clients can save as draft or save and request price from contractor
16
17         6) Contractor can set a price or mark a task description as needing
18         clarification.
19
20         5) Clients can approve price or edit further (or let it sit)
21
22         6) Clients can re-order the queue (the list of tasks which are approved
23         and priced, but work hasn't started yet)
24
25         7) Contractor can mark a task as in-progress at which point it is no longer
26         editable.
27
28         8) Contractor can mark a task as finished (needing testing). Then client can
29         test and mark it as confirmed finished.
30
31
32         Client's display is sorted into tasks needing their attention and tasks that
33         are waiting for contractor.
34
35         Contractor's display lists tasks needing his attention from all clients.
36         Contractor has additional page allowing him to switch his session to be logged
37         in as any of the clients.
38
39
40 Planned features in a probable order of appearance:
41
42         1) Contractor gets an e-mail whenever a client causes a task to move into
43         his list of things to attend to.
44
45         2) Contractor can add money to the client's balance, and system will
46         automatically mark finished tasks as paid, and reduce the balance.
47
48         3) Contractor can auto-generate an invoice from tasks and contact info in
49         the database.
50
51         4) Client can easily create invoices and make payments through paypal.
52
53         5) Site detects when client's balance is too low for work to continue and
54         displays that prominently to them.