Fresh 开源项目使用教程

Fresh 开源项目使用教程

freshBuild and (re)start go web apps after saving/creating/deleting source files.项目地址:https://gitcode.com/gh_mirrors/fre/fresh

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

Fresh 项目的目录结构如下：

fresh/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
├── config/
├── db/
├── public/
├── test/
├── Gemfile
├── Gemfile.lock
├── Rakefile
└── README.md

目录结构介绍

• app/：包含应用程序的主要代码，分为 controllers、models 和 views 三个子目录。
  • controllers/：存放控制器文件，处理用户请求。
  • models/：存放模型文件，与数据库交互。
  • views/：存放视图文件，负责展示数据。
• config/：包含应用程序的配置文件。
• db/：包含数据库相关的文件，如迁移文件等。
• public/：存放静态文件，如图片、CSS 和 JavaScript 文件。
• test/：包含测试文件。
• Gemfile：定义项目所需的 Ruby gems。
• Gemfile.lock：锁定 gem 版本。
• Rakefile：定义 Rake 任务。
• README.md：项目说明文档。

2. 项目的启动文件介绍

Fresh 项目的启动文件是 config.ru，位于项目根目录下。

require ::File.expand_path('../config/environment', __FILE__)
run Rails.application

启动文件介绍

• config.ru：使用 Rack 服务器启动 Rails 应用程序。
• require 语句加载 config/environment.rb 文件，该文件负责配置和初始化 Rails 应用程序。
• run Rails.application：运行 Rails 应用程序。

3. 项目的配置文件介绍

Fresh 项目的主要配置文件位于 config/ 目录下。

主要配置文件

• config/application.rb：包含应用程序的基本配置，如时区、语言等。
• config/database.yml：数据库配置文件，定义数据库连接信息。
• config/routes.rb：路由配置文件，定义 URL 和控制器动作的映射关系。
• config/environments/：包含不同环境（开发、测试、生产）的配置文件。
  • config/environments/development.rb：开发环境配置。
  • config/environments/test.rb：测试环境配置。
  • config/environments/production.rb：生产环境配置。

配置文件示例

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 Fresh
  class Application < Rails::Application
    # Initialize configuration defaults for originally generated Rails version.
    config.load_defaults 6.1

    # Configuration for the application, engines, and railties goes here.
    #
    # These settings can be overridden in specific environments using the files
    # in config/environments, which are processed later.
    #
    # config.time_zone = "Central Time (US & Canada)"
    # config.eager_load_paths << Rails.root.join("extras")
  end
end

config/database.yml

default: &default
  adapter: sqlite3
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000

development:
  <<: *default
  database: db/development.sqlite3

test:
  <<: *default
  database: db/test.sqlite3

production:
  <<: *default
  database: db/production.sqlite3

config/routes.rb

Rails.application.routes.draw do
  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html

  # Defines the root path route ("/")
  # root "articles#index"
end

通过以上介绍，您应该对 Fresh 项目的目录结构

freshBuild and (re)start go web apps after saving/creating/deleting source files.项目地址:https://gitcode.com/gh_mirrors/fre/fresh