ActiveAdmin 开源项目教程
1. 项目的目录结构及介绍
ActiveAdmin 是一个用于快速开发管理界面的 Ruby on Rails 插件。以下是其基本的目录结构:
activeadmin/
├── app/
│ ├── assets/
│ │ ├── images/
│ │ ├── javascripts/
│ │ └── stylesheets/
│ ├── controllers/
│ │ └── admin/
│ ├── helpers/
│ ├── models/
│ └── views/
│ └── layouts/
├── bin/
├── config/
│ ├── environments/
│ ├── initializers/
│ ├── locales/
│ └── routes.rb
├── db/
│ ├── migrate/
│ └── seeds.rb
├── lib/
│ ├── tasks/
│ └── active_admin/
├── spec/
├── test/
├── Gemfile
├── Gemfile.lock
├── Rakefile
└── README.md
目录结构介绍
app/
:包含应用程序的主要代码,如控制器、模型、视图等。assets/
:存放静态资源文件,如图片、JavaScript 和 CSS 文件。controllers/
:存放控制器文件,特别是admin/
目录下存放管理界面的控制器。helpers/
:存放辅助方法文件。models/
:存放模型文件。views/
:存放视图文件,特别是layouts/
目录下存放布局文件。
bin/
:包含可执行文件,如 Rails 脚本。config/
:包含配置文件,如环境配置、初始化文件和路由配置。environments/
:存放不同环境的配置文件。initializers/
:存放初始化文件。locales/
:存放本地化文件。routes.rb
:路由配置文件。
db/
:包含数据库相关文件,如迁移文件和种子文件。migrate/
:存放数据库迁移文件。seeds.rb
:种子文件,用于初始化数据库数据。
lib/
:包含自定义库和任务文件。tasks/
:存放自定义 Rake 任务文件。active_admin/
:ActiveAdmin 的核心代码。
spec/
和test/
:包含测试文件。Gemfile
和Gemfile.lock
:Gem 依赖管理文件。Rakefile
:Rake 任务配置文件。README.md
:项目说明文档。
2. 项目的启动文件介绍
ActiveAdmin 的启动文件主要位于 config/initializers/
目录下。以下是一些关键的启动文件:
active_admin.rb
:ActiveAdmin 的主要配置文件,包含管理界面的基本设置和配置。
# config/initializers/active_admin.rb
ActiveAdmin.setup do |config|
config.site_title = "My Admin"
config.authentication_method = :authenticate_admin_user!
config.current_user_method = :current_admin_user
config.logout_link_path = :destroy_admin_user_session_path
config.comments = false
end
3. 项目的配置文件介绍
ActiveAdmin 的配置文件主要位于 config/
目录下。以下是一些关键的配置文件:
routes.rb
:路由配置文件,用于定义管理界面的路由。
# config/routes.rb
Rails.application.routes.draw do
devise_for :admin_users, ActiveAdmin::Devise.config
ActiveAdmin.routes(self)
end
application.rb
:应用程序的主要配置文件,包含 Rails 应用程序的基本设置。
# config/application.rb
require_relative 'boot'
require 'rails/all'
Bundler.require(*Rails.groups)
module MyApp
class Application < Rails::Application
config.load_defaults 6.0
config.time_zone = 'Beijing'
config.i18n.default_locale = :zh
end
end
database.yml
:数据库配置文件,用于配置数据库连接信息