Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 2.33 KB

README.md

File metadata and controls

52 lines (43 loc) · 2.33 KB
Raw

RailRoad

railroad logo

A Ruby on Rails 6.0 template for fast development. The idea behind the template is faster === better. That's the reason this template uses things like Bootstrap, jQuery and RailsAdmin. The faster you can work on your actual product, the better.

The application is optimized for Heroku deployments so setup includes use of PostgreSQL database, Figaro for storing environment variables, processing background jobs using Redis + Sidekiq and more.

Utilizes

  • Rails 6.0
  • Ruby 2.7.1
  • Puma Webserver
  • PostgreSQL database - ready for Heroku
  • Redis
  • Includes Webpack

Includes

  • Authentication - Devise
  • SCSS + Bootstrap(v4.0)
  • jQuery (v3.5.1)
    • *optional - setup available for React or any other modern front-end framework with Webpack
  • Environment Variable Configuration - Figaro
  • Basic Marketing Website via StaticController
  • Pamyents - Stripe
  • Email - Mailgun
  • Admin Portal - RailsAdmin
  • Image + Document handling - Paperclip + AWS
    • Example within User.rb of how to set up attribute
    • Must have AWS keys within Figaro application.yml file
  • Ability to rename entire app - Rename
  • Background Jobs - Sidekiq

Installation Instructions

  1. Clone or Fork the repo
  2. gem install bundle && bundle install
  3. rake g rename:into new_name will rename your app from railroad to new_name
  4. rake db:create && rake db:migrate to set up and create database including User table
  5. bundle exec figaro install to use Figaro (Example)
  6. To access the RailsAdmin section of site, set the superuser attribute on your user account to true

Working locally

# Start development server
rails s

# For background jobs
redis-server
bundle exec sidekiq

# Start rails console
rails c