# The Arkenstone

[![Build Status](https://circleci.com/gh/ngscheurich/arkenstone.svg?&style=shield)](https://circleci.com/gh/ngscheurich/arkenstone)
[![Code Coverage](https://codecov.io/github/ngscheurich/arkenstone/coverage.svg?branch=master)](https://codecov.io/github/ngscheurich/arkenstone?branch=master)
[![Gem Version](https://badge.fury.io/rb/arkenstone.svg)](https://badge.fury.io/rb/arkenstone)

The Arkenstone is a Ruby on Rails development environment generator. Its
goal is to provide an easy way to spin up a new Vagrant box provisioned
for Rails development.

## Installation

    $ gem install arkenstone

## Usage

The Arkenstone provides you with the command line application `arkenstone`.
To create a new Arkenstone environment:

    $ arkenstone new path/to/app

Check out the `arkenstone help new` option to see the available
configuration options.

Once, you’ve generated your new environment, `cd` over to `path/to/app`
and run:

    $ vagrant up

Now go grab a cup of coffee or a glass of Scotch or two—this part might take a
while. If The Arkenstone detects a `SLACK_TOKEN` environment variable, it will
send a message to the associated [Slack](https://slack.com/) channel when its
done. For instance:

    $ env SLACK_TOKEN=Your/Token/1234 vagrant up

For now, The Arkenstone is busy building a new Vagrant box and doing some
initial work for you, such as:

- Installing system software depencies
- Building and installing Ruby
- Installing and setting up PostgreSQL
- Generating a new Rails app with [Suspenders](https://github.com/thoughtbot/suspenders)

When your new environment is complete, send over an SSH command to fire
up the Rails server:

    $ vagrant ssh -c '/vagrant/bin/rails server -b 0.0.0.0'
    
You should now be able to visit the new Rails app on your host machine at
[http://localhost:3001](http://localhost:3001).

*Voilà!*

---

Copyright (c) 2016 Nicholas Scheurich under the [MIT License (MIT)](https://opensource.org/licenses/MIT)