From baae242de3f8f1e19e5088fd4cdc4f7d58a8e56e Mon Sep 17 00:00:00 2001 From: Ryan Bates Date: Wed, 23 Oct 2013 09:07:04 -0700 Subject: [PATCH] add README docs --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ README.rdoc | 0 2 files changed, 38 insertions(+) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e6e098 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Rogue Rails Starter App + +This app is the initial project you should start with at the Rogue Rails workshop. + +## Setup + +First ensure you have [Vagrant](http://www.vagrantup.com) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads) installed. + +You should have already received the `roguerails.box` file. If you do not have it, ask one of the team mentors. Then add the box if you haven't already. + +``` +vagrant box add roguerails-box path/to/roguerails.box +``` + +Next clone this repository and run this command inside. + +``` +vagrant up +``` + +This will start up the virtual environment. If you receive an error, you may want to try it again with `vagrant halt` and `vagrant up`. + +Then you can SSH into the virtual box: + +``` +vagrant ssh +``` + +This will drop you into the `/vagrant` directory which is a shared folder allowing you to run the application. Run the following commands in the box to finish setting up the project. + +``` +bundle install +cp config/database.example.yml config/database.yml +rake db:create +rails s +``` + +From here you should be able to access the application at http://localhost:3000/ diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index e69de29..0000000