/rails-tabler-starter

Free and open source Ruby on Rails starter built using Tabler

Primary LanguageRubyMIT LicenseMIT

rails-tabler-starter

Rails starter boilerplate that you can clone and build on top of

Click here to view demo application. Check out the Demo setup page to toggle application settings.

Overview

  • User authentication & authorization

    • Authentication through Devise
    • Use OmniAuth to extend authentication using providers
    • Authorization thought Pundit

  • Background worker & scheduler

  • Role management

    • Supports standard roles available across spaces and also creating custom roles per space
    • Supports fine grained permissions per role

  • Multiple user groups support

    • The Space model is used to represent a group i.e. can be a team, organization, group etc.
    • Example use case for turning on multi-space mode is a saas application
    • Example use case for turning off multi-space mode is an internal org tool

  • Pre built UI layouts

    • High quality UI elements and layouts from Tabler

  • Development focussed

    • Annotate - Annotate Rails classes with schema and routes info
    • Brakeman - A static analysis security vulnerability scanner
    • Byebug - Simple debugger
    • Dotenv - Load environment variables from .env

Goals

Users familiar with rails should be able to build with this boilerplate without requiring extensive introduction.

  • No DSL
  • Avoid complex frontend functionality
  • Simplicity over efficiency

Setup

requires postgres and redis to run on local

brew install postgresql@12 redis

clone the repo

git clone https://github.com/tarunvelli/rails-tabler-starter.git

use asdf to install required dependencies, or setup the dependencies .tool-versions in another way

asdf install

setup and run dev server

bin/setup
bin/dev

Mark a user as admin from console to view admin features in the user dropdown

bundle exec rails c
> User.first.update(admin: true)

AppSettings

Toggle app settings at /setup/edit

  • AppSettings.interface_layout

    • Layout of app
    • values ["VERTICAL", "HORIZONTAL", "OVERLAP", "CONDENSED"]

  • AppSettings.interface_mode

    • Light/Dark mode of app
    • "SYSTEM" picks the mode from system preferences
    • Values ["LIGHT", "DARK", "SYSTEM"]

  • AppSettings.interface_theme

    • Color theme of app
    • Values ["DEFAULT", "COOL"]

  • AppSettings.login_layout one of

    • Layout of login screens
    • Values ["DEFAULT", "ILLUSTRATION", "COVER"]

  • AppSettings.multi_space_mode

    • When true allows users to sign up and create spaces
    • When false allows only admin to invite users and create spaces
    • Values [true, false]

  • AppSettings.show_landing_page

    • When true root path renders landing page
    • When false root path redirects to sign in page
    • Values [true, false]

Deployment

TODO: instructions to deploy on fly.io etc.

Contribution

Contribution is welcome!