forked from mazondo/Punchy
-
Notifications
You must be signed in to change notification settings - Fork 5
/
README
65 lines (39 loc) · 2.81 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
==Welcome to Punchy!
Punchy is a super simple, straight forward rails 3.0 app that allows you to keep track of what you've been working on.
==How it works
The premise is simple: setting up projects and clients sucks. No drop down menus, one button, nothing else. You can begin logging your work within seconds. To input a new time punch, simply type in something to the effect of "*programmed for @client_1 for 4 hours on #project_1" Anything starting with a "*" is recorded as an action, "#" is recorded as a project and "@" is recorded as a client.
That's it! Punchy will keep track of all the minutes you work and let you know where all your time is going!
==Why?
I developed Punchy so I could log the time I spend on various projects the way I choose to - with minimal interference in my day. I prefer to work without interference and then log my time after the fact.
==Deploying on Heroku
Punchy can be deployed on Heroku! To do so, you just need to make sure you use the bamboo stack because Punchy uses Rails 3.0. Run the following commands to get up and running in seconds:
heroku create your_subdomain --stack bamboo-ree-1.8.7
git push heroku master
heroku rake db:migrate
and you're done, except the time zone defaults to UTC. Read the next section to setup your own timezone.
==But the days are all messed up?
Punchy is currently set to UTC. If you live elsewhere, you'll need to run:
rake time:zones:all
in your local environment to get a legal list of values. Pick a relevant one and then run:
heroku config:add MY_TIME_ZONE="Eastern Time (US & Canada)"
==License
Released under the MIT License:
Copyright (c) 2011 Jay Godse
License: MIT - same as the one from Ryan Quinn below.
This app was derived from Ryan Quinn's Punchy, with the following license.
Copyright (c) 2011 Ryan Quinn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.