Maguro

Maguro is the base Rails application used at Bottega8.

It's goal is to do all the boring configuration of setting up a new project for you automatically, so you can get to the fun development part in seconds instead of hours.

What does the template do?

Maguro will create a basic Rails project that is optimized for Bottega8's workflow by:

1. Saving RVM configuration files
2. Creating a basic README.md
3. Setting up local git repository, gitinit file, and development branch
4. Generating app_environment_variables.rb for custom environment variables
5. Removing Turbolinks
6. Including RSpec, capybara, database_cleaner, factory_girl, and other gems for testing
7. Using PostgreSQL as the database and generating database.yml

Optionally, Maguro can also

1. Create a Heroku application for staging and production environments
2. Create a Git repository on Github.com, and pushing the newly-created Rails project to it
3. Create a Git repository on BitBucket.org, and pushing the newly-created Rails project to it
4. Securely store BitBucket.org credentials in the OS X keychain for convenience
5. Create a local postgres database for the project

Gem Prerequisites

Before running Maguro:

1. Install PostgreSQL for OS X
2. Install Ruby. We recommend using the Ruby Version Manager

Optional:

1. Heroku toolbelt if you want to automatically deploy to heroku.
2. Hub if you want to create a remote repository on github. brew install hub with homebrew.
3. OSX Keychain if you want to save your bitbucket credentials.

Gem Usage

Install the gem:

gem install maguro

Create a new app:

maguro new $APP_NAME

Detailed Usage

1. Switch to directory where new project will live. E.g. cd ~/Desktop/projects
2. Install the maguro gem gem install maguro
3. Generate the new project: maguro new $APP_NAME
4. Open config/database.yml and replace username with the same username when setting up Postgres
5. Run rake db:create db:migrate

Options

maguro new --help to see more options.

Development and testing steps

To make local changes to this gem, clone this repository then:

1. Clone this repository
2. Run bundle install to install development dependencies
3. Develop/modify the source code
4. Run unit and integration tests with rspec
5. Build the gem gem build maguro.gemspec
6. Switch to the directory where you want to create a new project. E.g. cd ~/Desktop/projects
7. Install the gem gem install ./maguro-0.0.1.gem
8. Follow instructions in the section Gem Usage, i.e. maguro new [APP_NAME]