README.md

Kickstart rails app template (API version)

Usage

1. Install

• PostgreSQL database
• Redis key-value server
• Memcached server
• ruby using rbenv
• ruby on rails using gem install rails

2. Create app using template

rails new APP_NAME --api -T -d postgresql -m https://raw.githubusercontent.com/alec-c4/ks-rails-api/master/template.rb

3. Create all required accounts:

• Digital Ocean or Linode
• Appsignal
• Postmark

4. Configure Appsignal with bundle exec appsignal install APPSIGNAL_KEY

5. Setup hypershield gem for PostgreSQL

6. Configure application secrets with following template

active_record_encryption:
  primary_key: ''
  deterministic_key: ''
  key_derivation_salt: ''
secret_key_base: ''
postmark:
  api_key: ''

You can generate active record encryption keys with following command

bin/rails db:encryption:init

7. Configure application in config/settings.yml

8. Configure rack-attack using following guide

What's inside

• ruby on rails application template

• .gitignore file

• VSCode configuration files

• postgresql database connector

• online_migrations

• pre-configured generators

• I18n tools - rails-i18n and i18n-tasks

• rspec for testing

• standard.rb for code style validations

• bullet to prevent N+1 problems

• brakeman and bundler-audit as security scanners

• pry-rails and amazing_print for better rails console

• rack-attack to prevent bruteforce and DDoS attacks

• lefthook with pre-commit run of rspec, brakeman, standardjs, standardrb and erblint

• semantic_logger as a highly configurable logging system

• simplecov for test coverage research

• hypershield

• identity_cache

TODO

• add deployments tools
• add documentation (howto's, best practices, curated list of libraries)