Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Matt Swanson
committed
Apr 26, 2013
1 parent
f43dce3
commit c91ab0a
Showing
2 changed files
with
75 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2013 Matt Swanson | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,62 @@ | ||
A work-in-progress, self-hosted, anti-social RSS reader. | ||
|
||
![](https://raw.github.com/swanson/stringer/master/screenshots/instructions.png) | ||
|
||
![](https://raw.github.com/swanson/stringer/master/screenshots/feed.png) | ||
|
||
The app is currently under active development, if you would like to try it out, please be aware that things are will be breaking at a rapid pace. | ||
|
||
# Installation | ||
|
||
* Clone the repository | ||
`git clone git://github.com/swanson/stringer.git` | ||
|
||
* Deploy to Heroku | ||
`heroku create` | ||
`heroku addons:add scheduler` | ||
`git push heroku master` | ||
|
||
* Setup the database | ||
`heroku run rake db:migrate` | ||
`heroku restart` (needed for DelayedJob) | ||
|
||
* Setup feed fetching | ||
`heroku addons:open scheduler` | ||
Add an hourly task that runs `rake fetch_feeds` | ||
|
||
* Follow the app setup | ||
`heroku open` | ||
|
||
# Niceities | ||
|
||
* Custom `reader.yourdomain.com` | ||
`heroku domains:add reader.yourdomain.com` | ||
|
||
Go to your registrar and add a CNAME: | ||
Record: CNAME | ||
Name: reader | ||
Target: your-heroku-instance.herokuapp.com | ||
|
||
Wait a few minutes for changes to progate. | ||
|
||
* Avoid dyno idle | ||
Single dyno Heroku apps idle after a period of inactivity. | ||
|
||
You can setup a ping/availability service to prevent this. | ||
|
||
# Development | ||
|
||
Run the tests with `rspec`. | ||
|
||
In development, stringer uses sqlite - there are issues with locking if you run background jobs at the same time as queries are being made via the web app. If you run into these, consider using postgres locally. | ||
|
||
# License | ||
MIT | ||
|
||
|
||
It looks something like this at the moment: | ||
|
||
![](https://raw.github.com/swanson/stringer/master/screenshots/instructions.png) | ||
|
||
![](https://raw.github.com/swanson/stringer/master/screenshots/feed.png) | ||
|
||
![](https://raw.github.com/swanson/stringer/master/screenshots/rss-zero.png) | ||
![](https://raw.github.com/swanson/stringer/master/screenshots/rss-zero.png) | ||
|