Base Rails App

This is a new, empty, Rails 5 app for use as a base for your next build. It comes packaged with:

• Rails 5.0.0
• Ruby 2.3.1
• ActiveRecord
• PostgreSQL
• RSpec
• Capybara
• Launchy for RSpec save_and_open_page
• Letter Opener for pop-up testing of mailers
• Fabrication (to generate test objects)
• Faker (for fake data)
• Pry (for debugging)
• Rubocop (Ruby code style enforcer)
• Simplecov (code coverage enforcer)
• Dotenv (for development env variables)
• rails_12_factor for Heroku

HOW TO GET STARTED

You will need to clone the app, cd into the folder, remove git, run bundle, rename the app and then reset git pointing it to your new remote. Once that is done you can begin developing your amazing new app...

git clone git@github.com:tommotaylor/base_rails_app.git
cd base_rails_app
rm -rf .git
bundle install
rails g rename:app_to NEW_NAME

Once renamed

You'll need to cd out of your app directory and then back into the newly renamed folder. You will also need to manually rename a few things:

• the <title> in app/views/layouts/application.html.erb
• all references to base_rails_app in config/database.yml
• you can also remove gem rename from the Gemfile and run bundle

Create a new git remote repository on github.com, then push your renamed app:

git init
git add -A
git commit -m "first commit"
git remote add origin git@github.com:YOUR_NEW_REMOTE_NAME
git push -u origin master

Now check its all working

You should now be able to create your database and spin up the server to check its all working:

rake db:create
rake db:migrate
rails s

TESTING

Tested using RSpec. In the app directory run rspec to test the entire application.

CODE COVERAGE

Run the test suite with the environmental variable COV=1 eg: COV=1 rspec to trigger SimpleCov for coverage testing.

CODE STYLE

Code style enforced using Rubocop to test the code base run cop -D from the terminal.