Intercom-Rails 项目使用教程

Intercom-Rails 项目使用教程

intercom-railsThe easiest way to install Intercom in a Rails app.项目地址:https://gitcode.com/gh_mirrors/in/intercom-rails

1. 项目的目录结构及介绍

Intercom-Rails 项目的目录结构如下：

intercom-rails/
├── circleci/
├── github/
├── lib/
│   ├── intercom-rails/
│   └── intercom-rails.rb
├── spec/
├── .gitignore
├── Gemfile
├── MIT-LICENSE
├── README.md
├── RELEASING.md
├── Rakefile
└── intercom-rails.gemspec

目录介绍

• circleci/: 包含 CircleCI 配置文件。
• github/: 包含 GitHub 相关配置文件。
• lib/: 包含项目的主要代码文件。
  • intercom-rails/: 包含 Intercom-Rails 的具体实现代码。
  • intercom-rails.rb: 项目的主文件。
• spec/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• Gemfile: Ruby 项目的依赖管理文件。
• MIT-LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• RELEASING.md: 发布指南。
• Rakefile: Rake 任务配置文件。
• intercom-rails.gemspec: 项目的 gemspec 文件。

2. 项目的启动文件介绍

Intercom-Rails 项目的启动文件是 lib/intercom-rails.rb。这个文件负责加载 Intercom-Rails 的主要功能和配置。

# lib/intercom-rails.rb
require 'intercom-rails/version'
require 'intercom-rails/config'
require 'intercom-rails/proxy'
require 'intercom-rails/proxy/user'
require 'intercom-rails/proxy/company'
require 'intercom-rails/script_tag'
require 'intercom-rails/auto_include_filter'
require 'intercom-rails/controller_methods'
require 'intercom-rails/railtie'

启动文件功能

• 加载版本信息 (intercom-rails/version)。
• 加载配置模块 (intercom-rails/config)。
• 加载代理模块 (intercom-rails/proxy)。
• 加载脚本标签模块 (intercom-rails/script_tag)。
• 加载自动包含过滤器模块 (intercom-rails/auto_include_filter)。
• 加载控制器方法模块 (intercom-rails/controller_methods)。
• 加载 Railtie 模块 (intercom-rails/railtie)。

3. 项目的配置文件介绍

Intercom-Rails 项目的配置文件是通过生成器生成的，可以通过以下命令生成配置文件：

rails generate intercom:config YOUR-APP-ID

配置文件内容

生成的配置文件位于 config/initializers/intercom.rb，内容如下：

IntercomRails.config do |config|
  config.app_id = 'YOUR-APP-ID'

  # 其他配置选项
  # config.include_for_logged_out_users = true
  # config.hide_default_launcher = true
  # config.enabled_environments = ["production"]
end

配置选项

• app_id: 你的 Intercom 应用 ID。
• include_for_logged_out_users: 是否包含未登录用户的聊天功能。
• hide_default_launcher: 是否隐藏默认的聊天启动按钮。
• enabled_environments: 指定启用 Intercom 的环境。

通过这些配置选项，你可以根据需要自定义 Intercom-Rails 的行为。

intercom-railsThe easiest way to install Intercom in a Rails app.项目地址:https://gitcode.com/gh_mirrors/in/intercom-rails