magrathealabs/mecha

# <%= app_name.humanize %>

- [Dependencies](#dependencies)
- [Setup](#setup)
- [Development](#development)
- [Staging](#staging)
- [Style](#style)

## Dependencies

- Ruby >= <%= Mecha::RUBY_VERSION %>
- PostgreSQL 9.6.1

### MacOS

```sh
brew update
brew install postgres
gem install bundler
```

### Ubuntu

```sh
apt-get update
apt-get postgresql postgresql-contrib postgresql-server-dev-all cmake
gem install bundler
```

## Setup

```sh
bundle install
cp config/database.yml.example config/database.yml
bin/rails db:setup
```

## Development

Run the local server at http://localhost:3000 with:

```sh
bin/rails s
```

Check code style with:

```sh
rubocop
```

Run tests with:

```sh
bin/rails t
```

Use guard to run tests and check code style as you code:

```sh
guard
```

You can check test coverage information by running the test suite and looking into `coverage/` folder:

```sh
bin/rails test
open coverage/index.html
```

## Staging

We're using Heroku as Staging environment. Take a look in the
[documentation](https://devcenter.heroku.com/articles/getting-started-with-rails5) to setup Heroku in your machine.

```sh
git push heroku master
heroku run rails db:migrate
```

## Style

- [Ruby style guide](https://github.com/bbatsov/ruby-style-guide)
- [Rails style guide](https://github.com/bbatsov/rails-style-guide)
- [JavaScript style guide](https://github.com/airbnb/javascript)