Plexy 开源项目使用教程
plexyA toolkit for building excellent APIs with Elixir项目地址:https://gitcode.com/gh_mirrors/pl/plexy
1. 项目的目录结构及介绍
Plexy 项目的目录结构如下:
plexy/
├── app/
│ ├── assets/
│ ├── controllers/
│ ├── models/
│ ├── views/
│ └── helpers/
├── config/
│ ├── environments/
│ ├── initializers/
│ └── application.rb
├── db/
│ ├── migrate/
│ └── seeds.rb
├── lib/
│ └── tasks/
├── public/
├── spec/
├── vendor/
├── Gemfile
├── Gemfile.lock
├── Rakefile
└── config.ru
目录结构介绍
app/
: 包含应用程序的主要代码,包括控制器、模型、视图和辅助方法。config/
: 包含应用程序的配置文件,包括环境配置和初始化文件。db/
: 包含数据库相关的文件,如迁移文件和种子数据。lib/
: 包含自定义库和任务。public/
: 包含静态文件,如图片、CSS 和 JavaScript 文件。spec/
: 包含测试代码。vendor/
: 包含第三方库和插件。Gemfile
: 定义项目所需的 Ruby gems。Gemfile.lock
: 锁定 gem 版本。Rakefile
: 定义 Rake 任务。config.ru
: 用于启动应用程序的 Rack 配置文件。
2. 项目的启动文件介绍
Plexy 项目的启动文件是 config.ru
。这个文件使用 Rack 来启动应用程序。
# config.ru
require_relative 'config/environment'
run Rails.application
启动文件介绍
require_relative 'config/environment'
: 加载应用程序的环境配置。run Rails.application
: 运行 Rails 应用程序。
3. 项目的配置文件介绍
Plexy 项目的配置文件主要位于 config/
目录下。
主要配置文件
config/application.rb
: 包含应用程序的基本配置,如时区、编码等。config/environments/
: 包含不同环境的配置文件,如development.rb
,test.rb
,production.rb
。config/initializers/
: 包含初始化代码,如数据库配置、中间件配置等。
配置文件示例
# 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 Plexy
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
环境配置文件示例
# config/environments/development.rb
Rails.application.configure do
# Settings specified here will take precedence over those in config/application.rb.
# In the development environment your application's code is reloaded on
# every request. This slows down response time but is perfect for development
# since you don't have to restart the web server when you make code changes.
config.cache_classes = false
# Do not eager load code on boot.
config.eager_load = false
# Show full error reports.
config.consider_all_requests_local = true
# Enable/disable caching. By default caching is disabled.
# Run rails dev:cache to toggle caching.
if Rails.root.join('tmp', 'caching-dev.txt').exist?
config.action_controller.perform_caching = true
config.action_controller.enable_fragment_cache_logging = true
config.cache_store = :memory_store
config.public_file_server.headers = {
'Cache-Control' => "public, max-age
plexyA toolkit for building excellent APIs with Elixir项目地址:https://gitcode.com/gh_mirrors/pl/plexy