开源项目 Ghee 使用教程
1. 项目的目录结构及介绍
Ghee 项目的目录结构如下:
ghee/
├── app/
│ ├── controllers/
│ ├── models/
│ ├── views/
│ └── helpers/
├── config/
│ ├── environments/
│ ├── initializers/
│ └── application.rb
├── db/
│ ├── migrate/
│ └── seeds.rb
├── lib/
│ └── tasks/
├── public/
│ ├── images/
│ ├── javascripts/
│ └── stylesheets/
├── test/
│ ├── controllers/
│ ├── models/
│ ├── views/
│ └── test_helper.rb
├── Gemfile
├── Gemfile.lock
└── README.md
目录结构介绍
app/
: 包含应用程序的主要代码,包括控制器、模型、视图和辅助方法。config/
: 包含应用程序的配置文件,包括环境配置和初始化文件。db/
: 包含数据库相关的文件,如迁移文件和种子数据。lib/
: 包含自定义库和任务。public/
: 包含静态文件,如图片、JavaScript 和样式表。test/
: 包含测试文件,包括控制器、模型和视图的测试。Gemfile
和Gemfile.lock
: 定义项目的依赖关系。README.md
: 项目说明文档。
2. 项目的启动文件介绍
Ghee 项目的启动文件是 config/application.rb
。这个文件负责加载应用程序的基本配置和依赖项。
require_relative "boot"
require "rails/all"
# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)
module Ghee
class Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
config.load_defaults 6.0
# Settings in config/environments/* take precedence over those specified here.
# Application configuration can go into files in config/initializers
# -- all .rb files in that directory are automatically loaded after loading
# the framework and any gems in your application.
end
end
启动文件介绍
require_relative "boot"
: 加载引导文件。require "rails/all"
: 加载 Rails 的所有组件。Bundler.require(*Rails.groups)
: 加载 Gemfile 中定义的 gem。module Ghee
: 定义应用程序的模块。class Application < Rails::Application
: 定义应用程序类,并进行基本配置。
3. 项目的配置文件介绍
Ghee 项目的配置文件主要位于 config/
目录下。
配置文件介绍
config/application.rb
: 应用程序的基本配置文件。config/environments/
: 包含不同环境的配置文件,如development.rb
,test.rb
, 和production.rb
。config/initializers/
: 包含初始化文件,如assets.rb
,backtrace_silencers.rb
等。config/database.yml
: 数据库配置文件。
config/application.rb
module Ghee
class Application < Rails::Application
# 设置默认配置
config.load_defaults 6.0
# 其他配置项
config.time_zone = 'Beijing'
config.i18n.default_locale = :en
end
end
config/environments/development.rb
Rails.application.configure do
# 开发环境配置
config.cache_classes = false
config.eager_load = false
config.consider_all_requests_local = true
config.action_controller.perform_caching = false
config.active_support.deprecation = :log
config.active_record.migration_error = :page_load
end
config/database.yml
default: &default
adapter: sqlite3
pool: <%= ENV.fetch("RAILS_MAX