Gilani's Starter App

This is my highly opinionated web app starter based on Ruby on Rails. I found myself heavily customizing Rails at the start of every project, so I created a starter with everything I like.

>>> Live Preview | Tips <<<

Details

Preconfigured

• Rspec
• Guard
• HAML
• Postgresql
• Livereload
• Simplecov
• Rubocop
• Devise
• Pundit
• Yard
• Annotated Models
• Semantic UI
• dotenv and config
• Real Favicon Generator
• Travis CI
• Coveralls

Versions

• Ruby 2.3
• Rails 5
• Bundler ~> 1.13.1

Dependencies

• Postgresql

Guides

A general list of customizations and information about the application.

Setup

Renaming

1. Change the name of the app from amingilani in:
   • config/application.rb
   • config/initializers/session_store.rb
   • config/database.yml
2. Change the hostname and port in config/settings/$ENVIRONMENT.yml to your setup's url and port
3. Change the smtp configuration in config/settings/$ENVIRONMENT.yml to yours

Authentication

Registrations accept email addresses and usernames, but a user can sign in with either of them

Creating a Favicon

This app comes with Real Favicon Generator already integrated. Quick edit:

1. Change the options in config/favicon.json
2. Replace the image in 'app/assets/images/logo/logo.png'
3. Run rails generate favicon

If you've never used Real Favicon Generator, visit the web site and follow the steps. Skip the part about editing the Gemfile.

Assets

All stylesheets, javascript and font files are precompiled.

The application layout loads two stylesheet and two javascript files per page:

• global (via application)
• controller_name

The following vendor folders are also precompiled:

• vendor/assets/javascripts
• vendor/assets/stylesheets
• vendor/assets/fonts