首页
/ Vanity 项目技术文档

Vanity 项目技术文档

2024-12-12 08:18:56作者:钟日瑜

安装指南

1. 添加 Gem

首先,在项目的 Gemfile 中添加 vanity 依赖:

gem "vanity"

2. 安装 Gem

运行以下命令安装 Gem:

bundle install

3. 配置数据存储

Vanity 支持多种数据存储方式,包括 Redis、MongoDB 和 SQL 数据库。根据你的需求选择合适的数据存储方式,并在 config/vanity.yml 中进行配置。

Redis 配置

Gemfile 中添加 Redis 依赖:

gem "redis", ">= 3.2"
gem "redis-namespace", ">= 1.1.0"

示例 config/vanity.yml 配置:

production:
  adapter: redis
  url: redis://<%= ENV["REDIS_USER"] %>:<%= ENV["REDIS_PASSWORD"] %>@<%= ENV["REDIS_HOST"] %>:<%= ENV["REDIS_PORT"] %>/0

MongoDB 配置

Gemfile 中添加 MongoDB 依赖:

gem "mongo", "~> 2.0"

示例 config/vanity.yml 配置:

production:
  adapter: mongodb
  database: analytics

SQL 数据库配置

Vanity 支持多种 SQL 数据库,如 MySQL、PostgreSQL 等。示例 config/vanity.yml 配置:

production:
  adapter: active_record
  active_record_adapter: postgresql
  host: <%= uri.host %>
  username: <%= uri.user %>
  password: <%= uri.password %>
  port: <%= uri.port %>
  database: <%= uri.path.sub('/', '') %>

4. 初始化

如果使用的是 Rails,Vanity 会自动初始化。否则,需要在应用启动时手动初始化:

Vanity.configure do |config|
  # 配置项
end
Vanity.connect!(
  adapter: :redis,
  redis: $redis
)
Vanity.load!

项目使用说明

1. 用户识别

Vanity 需要识别用户以进行 A/B 测试。在 Rails 中,可以通过以下方式配置:

class ApplicationController < ActionController::Base
  use_vanity :current_user
end

2. 定义 A/B 测试

experiments/price_options.rb 文件中定义 A/B 测试:

ab_test "Price options" do
  description "Mirror, mirror on the wall, who's the better price of all?"
  alternatives 19, 25, 29
  metrics :signups
end

3. 展示不同选项

在 Rails 模板中展示不同的选项:

<h2>Get started for only $<%= ab_test :price_options %> a month!</h2>

4. 测量转化

使用 Vanity.track! 方法记录转化:

class SignupController < ApplicationController
  def signup
    @account = Account.new(params[:account])
    if @account.save
      Vanity.track!(:signups)
      redirect_to @account
    else
      render action: :offer
    end
  end
end

5. 查看报告

生成报告并查看结果:

vanity report --output vanity.html

项目 API 使用文档

1. Vanity.ab_test

用于在模板或代码中展示 A/B 测试的不同选项。

Vanity.ab_test(:price_options)

2. Vanity.track!

用于记录用户转化。

Vanity.track!(:signups)

3. Vanity.connect!

用于连接到 Vanity 的数据存储。

Vanity.connect!(
  adapter: :redis,
  redis: $redis
)

4. Vanity.reconnect!

用于在分叉服务器(如 Passenger 或 Unicorn)中重新连接。

after_fork do |server, worker|
  defined?(Vanity) && Vanity.reconnect!
end

项目安装方式

1. 通过 Gemfile 安装

Gemfile 中添加 vanity 依赖,并运行 bundle install 进行安装。

2. 配置数据存储

根据需求选择 Redis、MongoDB 或 SQL 数据库,并在 config/vanity.yml 中进行配置。

3. 初始化

在应用启动时手动初始化 Vanity,或使用 Rails 自动初始化。

通过以上步骤,你可以成功安装并使用 Vanity 进行 A/B 测试。

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
373
72
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
276
72
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
200
47
xzs-mysqlxzs-mysql
学之思开源考试系统是一款 java + vue 的前后端分离的考试系统。主要优点是开发、部署简单快捷、界面设计友好、代码结构清晰。支持web端和微信小程序,能覆盖到pc机和手机等设备。 支持多种部署方式:集成部署、前后端分离部署、docker部署
HTML
5
1
LangChatLangChat
LangChat: Java LLMs/AI Project, Supports Multi AI Providers( Gitee AI/ 智谱清言 / 阿里通义 / 百度千帆 / DeepSeek / 抖音豆包 / 零一万物 / 讯飞星火 / OpenAI / Gemini / Ollama / Azure / Claude 等大模型), Java生态下AI大模型产品解决方案,快速构建企业级AI知识库、AI机器人应用
Java
10
3
gin-vue-admingin-vue-admin
🚀Vite+Vue3+Gin的开发基础平台,支持TS和JS混用。它集成了JWT鉴权、权限管理、动态路由、显隐可控组件、分页封装、多点登录拦截、资源权限、上传下载、代码生成器【可AI辅助】、表单生成器和可配置的导入导出等开发必备功能。
Go
16
3
source-vuesource-vue
🔥 一直想做一款追求极致用户体验的快速开发平台,看了很多优秀的开源项目但是发现没有合适的。于是利用空闲休息时间对若依框架进行扩展写了一套快速开发系统。如此有了开源字节快速开发平台。该平台基于 Spring Boot + MyBatis + Vue & Element ,包含微信小程序 & Uniapp, Web 报表、可视化大屏、三方登录、支付、短信、邮件、OSS...
Java
24
2
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
898
0
madongmadong
基于Webman的权限管理系统
PHP
4
0
cool-admin-javacool-admin-java
🔥 cool-admin(java版)一个很酷的后台权限管理框架,Ai编码、流程编排、模块化、插件化、CRUD极速开发,永久开源免费,基于springboot3、typescript、vue3、vite、element-ui等构建
Java
18
2