katzietang / static Goto Github PK

== About

Static is a super simple Rails CMS for Heroku.

Code: http://github.com/trevorturk/static/
Demo: http://static.heroku.com/
Screenshot: http://github.com/trevorturk/static/blob/master/public/screenshot.png


== Requirements 

Rails: http://guides.rubyonrails.org/getting_started.html
Git: http://book.git-scm.com/2_installing_git.html


== Installation

git clone git://github.com/trevorturk/static.git
cd static
cp config/database.example.yml config/database.yml
cp config/config.example.yml config/config.yml
rake db:create
rake db:schema:load
script/server
# http://localhost:3000/


== Deployment

sudo gem install heroku
heroku create
mate config/config.yml # configure the production environment
rake s3:create
rake heroku:config
git push heroku master
heroku rake db:schema:load
heroku open


== Upgrading

heroku db:pull sqlite://db/backup.sqlite3
git pull
mate config/config.example.yml # review possible changes
rake heroku:config
git push heroku master
heroku rake db:migrate
heroku open


== Stats

+----------------------+-------+-------+---------+---------+-----+-------+
| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers          |   104 |    83 |       4 |      13 |   3 |     4 |
| Helpers              |     2 |     2 |       0 |       0 |   0 |     0 |
| Models               |   119 |    90 |       3 |      13 |   4 |     4 |
| Libraries            |     0 |     0 |       0 |       0 |   0 |     0 |
| Integration tests    |    34 |    29 |       1 |       0 |   0 |     0 |
| Functional tests     |   146 |   121 |       3 |       0 |   0 |     0 |
| Unit tests           |   157 |   131 |       3 |       0 |   0 |     0 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total                |   562 |   456 |      14 |      26 |   1 |    15 |
+----------------------+-------+-------+---------+---------+-----+-------+
  Code LOC: 175     Test LOC: 281     Code to Test Ratio: 1:1.6


== MIT License

Copyright (c) 2009 Trevor Turk

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.