Sha256: 751b7bfaf76b237be674eb155a8efd4c49f62945a472f2afef65c7267b3eee35

Contents?: true

Size: 1.68 KB

Versions: 3

Compression:

Stored size: 1.68 KB

Contents

# <%= app_name.humanize %>

## Getting Started

After you have cloned this repo, run this setup script to set up your machine
with the necessary dependencies to run and test this app:

    % ./bin/setup

It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up
your machine with [this script].

[this script]: https://github.com/thoughtbot/laptop

After setting up, you can run the application using [foreman]:

    % foreman start

If you don't have `foreman`, see [Foreman's install instructions][foreman]. It
is [purposefully excluded from the project's `Gemfile`][exclude].

[foreman]: https://github.com/ddollar/foreman
[exclude]: https://github.com/ddollar/foreman/pull/437#issuecomment-41110407

## Assumptions
* [Mandrill](https://mandrill.com/) is used for email delivery on production
 * MANDRILL_API_KEY must be set as an ENV variable on the server
* [Honeybadger](https://www.honeybadger.io/) is used for Exception monitoring
 * Remember to run `bundle exec honeybadger install API_KEY` with your API key on the staging and production servers.
* [Rspec](https://github.com/rspec/rspec-rails) is used as the testing library
* Postgres is the database in use
* [Simple form](https://github.com/plataformatec/simple_form) is used for building forms
* [High voltage](https://github.com/thoughtbot/high_voltage) gem is used for creating static pages

## Guidelines

Use the following Thoughtbot guides for getting things done, programming well, and
programming in style.

* [Protocol](http://github.com/thoughtbot/guides/blob/master/protocol)
* [Best Practices](http://github.com/thoughtbot/guides/blob/master/best-practices)
* [Style](http://github.com/thoughtbot/guides/blob/master/style)

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
hitfox-suspenders-1.0.2 templates/README.md.erb
hitfox-suspenders-1.0.1 templates/README.md.erb
hitfox-suspenders-1.0.0 templates/README.md.erb