Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 68 lines (38 sloc) 2.616 kb
79ae5c5 Jonathan Hoyt Added readme with description of application.
authored
1 # PDF Archive
2
3654154 Jonathan Hoyt Updated readme with instructions.
authored
3 PDF Archive is a simple PDF storage and retrieval system. Uploading a PDF will store it, create a preview image for search listings, and extract the text from it so it can be indexed for search.
4
5 ## Setup
6
7 git clone git://github.com/jonmagic/pdf_archive.git
8 cd pdf_archive
82f9631 Jonathan Hoyt Added instruction for installing bundler before running bundle.
authored
9 gem install bundle
3654154 Jonathan Hoyt Updated readme with instructions.
authored
10 bundle
11
12 ## Run the tests
13
14 bundle exec rake
15
16 ## Run the app and background worker
17
18 gem install foreman
19 foreman start
20
21 You can now open the app in your browser http://localhost:3000
22
dba7e6b Jonathan Hoyt Updated README with instructions for deploying to Heroku
authored
23 ## Running on Heroku
24
25 Running this on Heroku requires the following steps:
26
27 ### Step 1: Create the app on the Heroku Cedar stack
28
50eeb09 Jonathan Hoyt Update README.md
authored
29 gem install heroku
dba7e6b Jonathan Hoyt Updated README with instructions for deploying to Heroku
authored
30 heroku apps:create app_name --stack cedar
31
03e952d Jonathan Hoyt Set RACK_ENV to production on Heroku
authored
32 We also need to configure it to run in production
33
34 heroku config:add RACK_ENV=production
35
315cb32 Jonathan Hoyt Add MongoLab support.
authored
36 ### Step 2: Add a MongoDB Addon
dba7e6b Jonathan Hoyt Updated README with instructions for deploying to Heroku
authored
37
315cb32 Jonathan Hoyt Add MongoLab support.
authored
38 The MongoHQ or MongoLab Addons will give us a small free MongoDB instance for storing our documents.
dba7e6b Jonathan Hoyt Updated README with instructions for deploying to Heroku
authored
39
40 heroku addons:add mongohq:free
41
315cb32 Jonathan Hoyt Add MongoLab support.
authored
42 or
43
44 heroku addons:add mongolab:starter
45
dba7e6b Jonathan Hoyt Updated README with instructions for deploying to Heroku
authored
46 ### Step 3: Configure For S3
47
48 First setup an Amazon AWS account, get your key, secret, and create a bucket. Then take those values and configure the environment variables on Heroku.
49
6f17e82 Jonathan Hoyt Clean up README instructions.
authored
50 heroku config:add AWS_ACCESS_KEY_ID=<aws_access_key_id> \
51 AWS_SECRET_ACCESS_KEY=<aws_secret_access_key> \
52 BUCKET_NAME=<bucket_name>
dba7e6b Jonathan Hoyt Updated README with instructions for deploying to Heroku
authored
53
54 ### Step 4: Deploy to Heroku
55
56 git push heroku master
57
58 When it is finished deploying it will give you the url to your app. Visit in the browser and enjoy!
59
3654154 Jonathan Hoyt Updated readme with instructions.
authored
60 ## License
61
62 Copyright (c) 2011 Jonathan Hoyt
63
64 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:
65
66 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
67
68 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.
Something went wrong with that request. Please try again.