zacharywelch/rails-api-template

application template for rails-api

rails-api-template

A rails application template for APIs.

To see a sample of using Rails as an API check out rails-api-sample.

Installation

Before generating your API, you will need rails-api gem installed

gem install 'rails-api'

Usage

rails-api new [api_name] --skip-test-unit -m https://raw.githubusercontent.com/zacharywelch/rails-api-template/master/template.rb

What it does

1. Adds the following gems

• rails-api
• rails
• jbuilder
• responders
• faker
• kaminari
• spring
• sqlite3
• activerecord-sqlserver-adapter
• tiny_tds
• annotate
• rspec-rails
• factory_girl_rails
• shoulda-matchers
• simplecov
• codeclimate-test-reporter
• newrelic_rpm
• exception_notification
• byebug
• okcomputer
• lograge
• fluentd
• fluent-plugin-record-modifier
• rack-cors

Several custom gems add behaviors needed by CareerBuilder APIs

• json_responder
• paginate-responder
• rails_api_sortable
• partner_authentication

2. Runs bundle

3. Runs the following generators

• rspec:install
• responders:install
• partner_authentication:install

4. Adds a sample Partner ID for development

5. Removes ActionView and Sprockets from stack

6. Adds json as default format for routes

7. Configures rspec to exclude view, route, and controller specs

8. Hooks up JsonResponder and PaginateResponder to responder chain

9. Adds template for controller scaffold

10. Configures New Relic

11. Configures Code Climate

12. Configures lograge and fluentd, to be consummed from Sumo Logic

13. Creates sample config files and git ignores the original ones

• config/database.yml
• config/secrets.yml

14. Adds basic Swagger file to act as documentation.

15. Replaces README with markdown

16. Customizes .gitignore file

17. Creates initial github commit

Additional steps

Code Climate

Replace the badge placeholders in README.md with the markdown snippets from Code Climate.

TeamCity

Replace the badge placeholders in README.md with the markdown snippets from TeamCity.