Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 121 lines (68 sloc) 4.333 kb
fa50ac2 @rapind fixed devise config to work on heroku
authored
1 # Grokphoto
c3a9e47 @rapind updated readme
authored
2
9d50bcb @rapind updated readme
authored
3 Grokphoto is a professional photographer's client gallery solution.
c3a9e47 @rapind updated readme
authored
4
9d50bcb @rapind updated readme
authored
5 This version is work in progress / port to rails 3.1.3
c3a9e47 @rapind updated readme
authored
6
7 For the stable rails 2 version please see the version 2 branch:
5a92245 @rapind updated readme to point at the v2 branch url
authored
8 [Version 2](https://github.com/rapind/grokphoto/tree/v2.0)
c3a9e47 @rapind updated readme
authored
9
10
fa50ac2 @rapind fixed devise config to work on heroku
authored
11 ## Software Requirements
c3a9e47 @rapind updated readme
authored
12
13 * ImageMagick
fca1771 @rapind updated readme soft reqs
authored
14 * SQLite3 or MySQL or PostgreSQL
c3a9e47 @rapind updated readme
authored
15
fa50ac2 @rapind fixed devise config to work on heroku
authored
16
17 ## Installation
c3a9e47 @rapind updated readme
authored
18
405fc1f @rapind updated readme and removed $ to make copy and paste easier
authored
19 git clone git://github.com/rapind/grokphoto.git
20 cd grokphoto
21 bundle
e399ce1 @rapind fixed the init task and updated the README instructions
authored
22
6f47c22 @rapind updated readme
authored
23 Then edit these files with your own settings. Everything you need to change is marked with TODO along with instructions if necessary:
e399ce1 @rapind fixed the init task and updated the README instructions
authored
24
25 * config/database.yml
26 * config/heroku.yml
27 * config/initializers/devise.rb
28 * config/initializers/secret_token.rb
29 * config/initializers/session_store.rb
6f47c22 @rapind updated readme
authored
30
50d19a5 @rapind updated README for heroku config
authored
31 NOTE: You won't need to change all of these if you're deploying to Heroku. See Heroku Deployment below for details.
32
33
e399ce1 @rapind fixed the init task and updated the README instructions
authored
34 Then initialize the database and start the server:
c3a9e47 @rapind updated readme
authored
35
405fc1f @rapind updated readme and removed $ to make copy and paste easier
authored
36 rake db:create
37 rake db:migrate
38 rake db:seed
39 rails s
c3a9e47 @rapind updated readme
authored
40
3e1716e @rapind updated readme
authored
41 At this point you should have a working site with some basic seed data that you can start to customize.
c3a9e47 @rapind updated readme
authored
42
fa50ac2 @rapind fixed devise config to work on heroku
authored
43
44 ## Initial Configuration
c3a9e47 @rapind updated readme
authored
45
b457f65 @rapind fixed readme admin reference
authored
46 1. Login to the administration area (/admin) using photographer@grokphoto.org / password
c3a9e47 @rapind updated readme
authored
47 2. Click on the Settings tab.
48 3. Enter your own information and update the settings.
49
fa50ac2 @rapind fixed devise config to work on heroku
authored
50
51 ## Heroku Deployment
52
2951f51 @rapind updated carrierwave settings and readme for amazon s3 hosted images
authored
53 heroku create --stack cedar
fa50ac2 @rapind fixed devise config to work on heroku
authored
54
afcf490 @rapind removed example configs in favour of environment variables
authored
55 Setup your own values in the next command, using your own email address, the name of your application for the session key and "rake secret" to generate a new secret key.
56
57 heroku config:add SENDER_EMAIL=change_to_to_your_email@address.com SESSION_KEY=_change_me_to_your_app_name SECRET_KEY=result_of_rake_secret_goes_here
58 git push heroku master
2951f51 @rapind updated carrierwave settings and readme for amazon s3 hosted images
authored
59 heroku run rake db:migrate
60
61 Before you seed the database you'll need to setup an amazon s3 account and bucket to have somewhere to store the files. Heroku has a temporary filesystem which is not an appropriate place to store images.
62
63 * Go to: https://console.aws.amazon.com/s3/home
64 * Create a bucket
65 * Go to: https://aws-portal.amazon.com/gp/aws/developer/account/index.html
66 * Click on the Security Credentials in the left nav, then the Access Credentials in the body.
67 * Copy your S3 key and your S3 secret key
68
69 Use your S3 information to fill in the config vars for heroku, then seed the database.
70
50d19a5 @rapind updated README for heroku config
authored
71 heroku config:add S3_KEY=change_to_your_amazon_s3_key S3_SECRET=change_to_your_amazon_s3_secret S3_BUCKET=change_to_your_amazon_s3_bucket
72
73 You still need to specify a secret roken and session store key:
74
75 rake secret
76 heroku config:add SESSION_KEY=_usually_you_app_name SECRET_TOKEN=token_from_rake_secret
77
78 The specify the email address to use when the system sends emails:
79
80 heroku config:add SENDER_EMAIL=_your_email_address
81
2951f51 @rapind updated carrierwave settings and readme for amazon s3 hosted images
authored
82 You can check to make sure all of your heroku environment variables have been properly set using:
83
84 heroko config
50d19a5 @rapind updated README for heroku config
authored
85
86 Once done, seed the database and launch the app.
87
88 heroku run rake db:seed
89 heroku open
afcf490 @rapind removed example configs in favour of environment variables
authored
90
fa50ac2 @rapind fixed devise config to work on heroku
authored
91
92 ## Features
c3a9e47 @rapind updated readme
authored
93
94 * Personalize your site via the configuration / settings page.
3e1716e @rapind updated readme
authored
95 * Manage and share private galleries with clients easily via secure URL.
c3a9e47 @rapind updated readme
authored
96 * One-click photo uploads.
97
fa50ac2 @rapind fixed devise config to work on heroku
authored
98
99 ## TODO
6f47c22 @rapind updated readme
authored
100
3e1716e @rapind updated readme
authored
101 * Internationalization.
9d50bcb @rapind updated readme
authored
102 * Photo commenting system for both you and your clients.
103 * Basic view statistics / history for your client galleries.
c3a9e47 @rapind updated readme
authored
104
fa50ac2 @rapind fixed devise config to work on heroku
authored
105
106 ## Tests
32eb5e3 @rapind added some inline instructions for config files
authored
107
108 To run the tests:
109
bc7f52b @rapind type for rspec instructions
authored
110 rspec spec
32eb5e3 @rapind added some inline instructions for config files
authored
111
c3a9e47 @rapind updated readme
authored
112
fa50ac2 @rapind fixed devise config to work on heroku
authored
113 ## Credits
c3a9e47 @rapind updated readme
authored
114
115 Sample photos were provided by and are copyright of Jaime Coyle Photography [http://jaimecoyle.com](http://jaimecoyle.com)
116
117
fa50ac2 @rapind fixed devise config to work on heroku
authored
118 ## License
c3a9e47 @rapind updated readme
authored
119
b457f65 @rapind fixed readme admin reference
authored
120 <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/ca/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/2.5/ca/88x31.png" /></a><br /><span xmlns:dc="http://purl.org/dc/elements/1.1/" href="http://purl.org/dc/dcmitype/InteractiveResource" property="dc:title" rel="dc:type">Grokphoto</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://github.com/rapind/grokphoto" property="cc:attributionName" rel="cc:attributionURL">http://github.com/rapind/grokphoto</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/ca/">Creative Commons Attribution-Share Alike 2.5 Canada License</a>.<br />Based on a work at <a xmlns:dc="http://purl.org/dc/elements/1.1/" href="http://github.com/rapind/grokphoto" rel="dc:source">github.com</a>.
Something went wrong with that request. Please try again.