alec-c4 / ks-rails-bootstrap

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kickstart rails app template (bootstrap version)

Usage

  1. Install
  • PostgreSQL database
  • Redis key-value server
  • Memcached server
  • Node.js
  • yarn
  • ruby using rbenv
  • ruby on rails using gem install rails
  1. Create app using template
rails new APP_NAME --no-skip-hotwire -T -c bootstrap -j esbuild -d postgresql -m https://raw.githubusercontent.com/alec-c4/ks-rails-bootstrap/master/template.rb
  1. Create all required accounts:
  1. Configure Appsignal with bundle exec appsignal install APPSIGNAL_KEY

  2. Setup hypershield gem for PostgreSQL and create user for blazer gem

  3. Configure sitemap generator in config/sitemap.rb

  4. Configure application secrets with following template

active_record_encryption:
  primary_key: ''
  deterministic_key: ''
  key_derivation_salt: ''
secret_key_base: ''
devise:
  secret_key: ''
google:
  client_id: ''
  client_secret: ''
postmark:
  api_key: ''

You can generate active record encryption keys with following command

bin/rails db:encryption:init
  1. Configure application in config/settings.yml

  2. Configure rack-attack using following guide

  3. Add legal documents.

  4. Update error pages in app/views/errors/* with your content

  5. Update config/database.yml - just change configuration line for development from

development:
  <<: *default
  database: APP_NAME_development

to

development:
  <<: *default
  database: <%= ENV['CYPRESS'] ? 'APP_NAME_test' : 'APP_NAME_development' %>

Example configuration is available in config/database.yml.example

What's inside

TODO

  • add announcements (new/fix/update) for all users
  • add feedback
  • add 2FA for all users and enabled for admin accounts by default
  • add monitoring and analytics tools
  • add A11y
  • add deployments tools
  • add documentation (howto's, best practices, curated list of libraries)

About

License:MIT License


Languages

Language:Ruby 72.9%Language:HTML 21.5%Language:JavaScript 4.6%Language:Makefile 0.9%Language:SCSS 0.2%