Active Admin 技术文档

1. 安装指南

环境要求

• Ruby 版本：建议使用最新稳定版本。
• Rails 版本：建议使用最新稳定版本。

安装步骤

1. 在 Gemfile 中添加 Active Admin：

   gem 'activeadmin'
   

2. 运行以下命令安装 Gem：

   bundle install
   

3. 运行安装脚本以生成必要的文件和配置：

   rails generate active_admin:install
   

4. 运行数据库迁移：

   rails db:migrate
   

5. 启动 Rails 服务器：

   rails server
   

6. 访问 http://localhost:3000/admin，使用默认管理员账户登录（用户名：[e-mail]，密码：password）。

2. 项目的使用说明

创建管理员用户

• 默认情况下，Active Admin 会创建一个管理员用户。你可以通过以下命令创建新的管理员用户：

  rails generate active_admin:install User
  

添加资源

• 要为模型添加管理界面，运行以下命令：

  rails generate active_admin:resource ModelName
  

自定义界面

• 你可以通过编辑生成的 app/admin/model_name.rb 文件来自定义资源的管理界面。

添加过滤器

• 在资源文件中添加过滤器，例如：

  filter :name
  filter :created_at
  

添加操作项

• 在资源文件中添加操作项，例如：

  action_item :view, only: :show do
    link_to 'View on site', resource_path(resource)
  end
  

3. 项目API使用文档

基本API

• Active Admin 提供了一个强大的 DSL（领域特定语言），用于定义管理界面。以下是一些常用的 API：

资源定义

ActiveAdmin.register Post do
  index do
    column :title
    column :author
    column :created_at
    actions
  end
end

过滤器

filter :title
filter :author
filter :created_at

操作项

action_item :edit, only: :show do
  link_to 'Edit', edit_resource_path(resource)
end

侧边栏

sidebar "Recent Posts", only: :index do
  ul do
    Post.recent(5).each do |post|
      li link_to(post.title, admin_post_path(post))
    end
  end
end

4. 项目安装方式

通过 RubyGems 安装

• 在 Gemfile 中添加：

  gem 'activeadmin'
  

• 运行 bundle install 安装。

通过源码安装

1. 克隆仓库：

   git clone https://github.com/activeadmin/activeadmin.git
   

2. 进入项目目录：

   cd activeadmin
   

3. 安装依赖：

   bundle install
   

4. 运行测试：

   bundle exec rake
   

通过以上步骤，你可以成功安装并使用 Active Admin 项目。