Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Commit

Permalink
add README docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanb committed Oct 23, 2013
1 parent 1fc73ba commit baae242
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions 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/
Empty file removed README.rdoc
Empty file.

0 comments on commit baae242

Please sign in to comment.