rahulmahale/wheel

镜像概述

这是由BigBinary团队维护的Rails应用基础项目镜像，旨在帮助开发者快速搭建符合BigBinary工作风格的Rails应用，支持本地开发、Docker部署、Kubernetes部署及Heroku集成等多种场景。

核心功能

• 使用Bootstrap框架
• 提供rake setup命令快速设置示例数据（含用户sam@example.com，密码welcome）
• 集成Devise认证系统
• 支持Heroku部署
• 集成Honeybadger错误监控
• 内置超级管理员功能
• 支持模态框编辑信息
• JavaScript严格模式
• 使用Puma作为Web服务器
• 使用HAML替代ERB
• 无CoffeeScript，偏好原生JavaScript
• 集成Turbolinks
• 集成ActiveAdmin后台管理
• 异常上报时附带UUID便于调试
• 使用DelayedJob处理后台任务
• 非生产环境拦截所有外发邮件（通过mail_interceptor gem）
• 支持CircleCI持续测试
• 内置测试用例便于扩展
• 使用PostgreSQL数据库
• 集成Carrierwave支持S3上传
• 支持页面变体（针对平板/手机定制）
• 集成SimpleForm表单组件
• 支持Mailgun邮件服务
• 易生成测试覆盖率报告
• 通过Rack::Deflater实现内容压缩
• 使用Rubocop自动格式化Ruby代码
• 使用Prettier自动格式化JavaScript和CSS代码

使用场景

• 快速启动新的Rails应用开发
• 本地开发环境搭建
• Docker容器化部署
• Kubernetes集群部署
• Heroku云平台部署
• 团队协作开发符合统一风格的Rails项目

配置说明

本地开发设置

1. 安装最新版Node.js（需包含npm）
2. 执行以下命令：

bash
bundle install
bundle exec rake setup
bin/yarn
bundle exec rails server

3. 访问http://localhost:3000，使用***sam@example.com和密码welcome登录

Docker运行步骤

前提条件

确保已安装Docker和Docker Compose

启动Rails应用

bash
docker-compose up

容器创建成功后，访问http://localhost:9000即可使用应用

Kubernetes部署步骤

使用项目中提供的Kubernetes模板（路径：lib/templates/kubernetes）执行以下命令：

1. 创建PostgreSQL数据库及服务：

bash
kubectl create -f db-deployment.yml -f db-service.yml

2. 创建数据库配置映射：

bash
kubectl create -f database-configmap.yml

3. 创建Web/Puma部署及服务：

bash
kubectl create -f web-deployment.yml -f web-service.yml

4. 创建后台/DelayedJob部署及服务：

bash
kubectl create -f background-deployment.yml -f background-service.yml

5. 获取应用端点：

bash
kubectl get svc web -o wide | awk '{print $4}'

替换项目名称

若需将项目名称从Wheel改为Pump，执行以下命令：

bash
perl -e "s/Wheel/Pump/g;" -pi $(find . -type f)

Heroku Review支持

该应用已启用Heroku Review，提交PR时Heroku会自动为分支部署应用。

关于BigBinary

wheel由BigBinary维护，BigBinary是一家软件咨询公司，专注于使用Ruby on Rails、React.js、React Native和Elm构建Web及移动应用。