API Template

Setup

1. Clone this repo
2. Create your database.yml and application.yml file
3. bundle install
4. Generate a secret key with rake secret and paste this value into the application.yml
5. rake db:create
6. rake db:migrate
7. rails s

Optional configuration

• Set your frontend URL in config/initializers/rack_cors.rb
• Set your mail sender in config/initializers/devise.rb
• Decrease token_lifespan in config/initializers/devise_token_auth.rb if the frontend is a Web-app.
• Remove Facebook code with git revert a8319a37ab8d038399a7a6bd74fe3869bb3f3ddc
• Config your timezone accordingly in application.rb.

Docs

http://docs.rails5apibase.apiary.io

Code quality

With rake code_analysis you can run the code analysis tool, you can omit rules with:

• Rubocop Edit .rubocop.yml
• Reek Edit config.reek
• Rails Best Practices Edit config/rails_best_practices.yml
• Brakeman Run brakeman -I to generate config/brakeman.ignore
• Bullet You can add exceptions to a bullet initializer or in the controller