reloj 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b4826790d1742e7cc183f205261714e1a7b6c11
-  data.tar.gz: d0f2462f85d915f548328e2a7093681fc67a7dac
+  metadata.gz: 42da7fc580502d942eb23f8aa85102338741a544
+  data.tar.gz: 23060fa9e00ad5ced9d20dc86421283e398ab73d
 SHA512:
-  metadata.gz: 9e896f8d60a4d6021c299451884ee68ebb4d00f3e92f2aba128a86857426ac3532c7d1188f8804eb3dd4299dae0871fdf577f8bcd3f153f6fcfc8a56f3c4ea25
-  data.tar.gz: 61381c1aefdb117bf8c946dcbc210676e6e9c930dc7747b6793753196158438a2a4e355e52f601f5ef700b1dbc5729eb2697caaad9202d1789b81987c19b59c7
+  metadata.gz: 0d4eaaa5e8874830e9105d1bd68c492dfb4ee7aa65c0a0530ca1ca7c871cd569a38cf9f841252593b29202c77da8234dea73a20c756051ac3029d8d879fb30d2
+  data.tar.gz: 9fce521ca07a2c63c5dd6bd25ab6b2c322093597551ba4b5b163ca678cc904dbdbe2a6d0b54c1d13efcdc21569234818161b242fa21e06024de2a73913f6140d

data/README.md

@@ -22,6 +22,30 @@ A lightweight web framework for Ruby for creating database-backed web applicatio
 4. Using a browser, go to `http://localhost:3000` and you'll see:
 "Welcome to Reloj!"
 
+## Setting up the database
+
+Reloj has some built in convenience features to make it easy to set up your database
+
+To name your database, change the dbname value in `config/db.yml`. If you need to setup any other values for your local database (username, password, port), you can put them in the same file.
+
+To create a database for your app to use, just run:  
+
+		bundle exec rake db:create
+		
+To destroy the database, run:
+
+		bundle exec rake db:delete
+		
+To reset the database, run:
+
+		bundle exec rake db:reset
+		
+Finally, to setup your schema and seed your database, use the `db/setup.sql` file. To run this file on the app's databasae, run:
+
+		bundle exec rake db:setup
+		
+To learn how to manage the database when deploying, scroll down to the Deploy secction
+
 ## Models and ORM
 Reloj uses the active record pattern for its object-relational mapping.
 To use this functionality in your app, create a class for your model in `app/models` and have the model inherit from ModelBase
@@ -87,3 +111,34 @@ Reloj includes a generator for a sample app. To check it out:
 		reloj server
 
 4. Navigate to localhost:3000
+
+
+## Deploying
+Reloj is built to make deploying to heroku as easy as possible, here's how:
+
+1. Make sure there's a procfile in the project's root directory with the following line:
+
+		web: bundle exec reloj server
+
+		
+2. Commit your changes to git
+
+		git commit -am "procfile"
+		
+3. Create a new heroku app using the heroku cli
+
+		heroku apps:create mynewapp
+		
+4. Push your code to heroku (heroku apps:create should automatically add a remote repo to push to)
+
+		git push heroku master
+		
+5. Wait for the push to finish, then create your database tables and seed it as defined in `db/setup.sql`
+
+		heroku run rake db:setup
+		
+6. Wait for the rake task to finish, then open your app:
+
+		heroku open
+		
+Enjoy your now-deployed app!

data/lib/reloj/version.rb

@@ -1,3 +1,3 @@
 module Reloj
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reloj
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - ougarcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,13 +164,13 @@ files:
 - lib/reloj/orm/pg_db.rb
 - lib/reloj/orm/searchable.rb
 - lib/reloj/skeletons/common_files/Gemfile
+- lib/reloj/skeletons/common_files/Procfile
 - lib/reloj/skeletons/common_files/Rakefile
 - lib/reloj/skeletons/new_app/app/controllers/.keep
 - lib/reloj/skeletons/new_app/app/models/.keep
 - lib/reloj/skeletons/new_app/app/views/.keep
 - lib/reloj/skeletons/new_app/config/routes.rb
 - lib/reloj/skeletons/new_app/db/.keep
-- lib/reloj/skeletons/sample_app/Procfile
 - lib/reloj/skeletons/sample_app/app/controllers/cats_controller.rb
 - lib/reloj/skeletons/sample_app/app/models/cat.rb
 - lib/reloj/skeletons/sample_app/app/views/cats_controller/index.html.erb