rails tabler starter

Rails Tabler 入门版

您可以使用 Rails 入门样板快速构建和原型化。从想法到实施仅需数小时。

单击此处查看演示应用程序。查看演示设置页面以切换应用程序设置。

目标

本入门指南针对熟悉该框架的 Rails 开发人员，旨在通过以下原则促进无缝开发：

• 无 DSL：避免不必要的领域特定语言 (DSL) 复杂性。
• 简单性高于效率：优先考虑实施的简单性而不是过度优化。
• 避免复杂的前端功能：保持前端功能简单且易于管理。

概述

• 预先配备了基本模型，例如

  • 用户
  • 角色
  • 计划
  • 订阅

ERD

• 用户认证与授权

  • 通过 Devise 进行身份验证
  • OmniAuth 集成可使用第三方提供商扩展身份验证
  • 通过 Pundit 授权

• 后台工作者和调度程序

  • 使用 sidekiq 和 sidekiq-scheduler

• 角色管理

  • 跨空间可用的标准角色
  • 每个空间的自定义角色创建
  • 支持每个角色的细粒度权限

• 多用户命名空间支持

  • 利用Space模型来表示用户命名空间（例如团队、组织）。
  • 打开多空间模式的示例用例是 SaaS 应用程序
  • 关闭多空间模式的示例用例是内部组织工具

• 预构建的 UI 布局

  • Tabler 的高质量 UI 元素和布局

• 专注发展

  • Annotate - 使用架构和路由信息注释 Rails 类
  • Brakeman - 静态分析安全漏洞扫描器
  • Byebug - 简单的调试器
  • Dotenv - 从.env加载环境变量

设置

要设置项目，请确保本地安装了 PostgreSQL 和 Redis。使用以下命令来安装它们：

 brew install postgresql@12 redis

克隆存储库

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

使用 asdf 安装所需的依赖项或以其他首选方法设置依赖项.tool-versions ：

 asdf install

设置并运行开发服务器：

 bin/setup
bin/dev

要向用户授予管理权限并访问管理功能，请在 Rails 控制台中运行以下命令：

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

应用程序设置

在/setup/edit处切换应用程序设置

• AppSettings.interface_layout

  • 应用程序的布局
  • 值 [“垂直”、“垂直透明”、“水平”、“重叠”、“压缩”]

• AppSettings.interface_mode

  • 应用程序的亮/暗模式
  • “SYSTEM”从系统首选项中选择模式
  • 值 [“亮”、“暗”、“系统”]

• AppSettings.interface_theme

  • 应用程序的颜色主题
  • 值 [“默认”、“酷”]

• AppSettings.login_layout之一

  • 登录屏幕的布局
  • 值 [“默认”、“插图”、“封面”]

• AppSettings.multi_tenant_mode

  • 当 true 时允许用户注册并创建空间
  • 当 false 时，仅允许管理员邀请用户并创建空间
  • 值[真、假]

• AppSettings.show_landing_page

  • 当真正的根路径呈现登陆页面时
  • 当错误根路径重定向到登录页面时
  • 值[真、假]

部署

选择您首选的部署平台：

• 在 Fly.io 上部署
• 部署在 Heroku 上

贡献

强烈鼓励和欢迎为增强此启动器做出的贡献！请随意提交拉取请求并协作改进项目。