Sapphire 项目启动与配置教程

1. 项目目录结构及介绍

Sapphire 项目的目录结构如下所示：

sapphire/
├── .gitignore           # 指定git应该忽略的文件和目录
├── .vscode              # Visual Studio Code项目配置
├── Dockerfile           # Docker配置文件，用于创建容器镜像
├── Gemfile              # Ruby项目依赖文件
├── Gemfile.lock         # 锁定依赖版本
├── README.md            # 项目说明文件
├── Rakefile             # Rake任务文件
├── config               # 配置目录
│   ├──.ru               # Rack配置文件
│   ├── boot.rb          # 项目启动配置
│   ├── database.yml     # 数据库配置
│   └── routes.rb        # 路由配置
├── lib                  # 库目录
│   ├── sapphire.rb      # 主模块文件
│   └── version.rb       # 版本信息文件
├── public               # 公共文件目录
│   └── index.html       # 默认页面
├── spec                 # 测试目录
│   ├── spec_helper.rb   # 测试辅助文件
│   └── sapphire_spec.rb # 测试文件
└── vendor               # 第三方库目录

目录说明：

• .gitignore: 指定在git版本控制中应该忽略的文件和目录。
• .vscode: 存储Visual Studio Code项目的配置文件。
• Dockerfile: Docker配置文件，用于构建项目的Docker容器。
• Gemfile 和 Gemfile.lock: Ruby项目的依赖文件，用于管理项目的依赖库。
• README.md: 项目说明文件，包含项目的基本信息和安装指南。
• Rakefile: 定义项目的Rake任务，如数据库迁移、测试等。
• config: 配置目录，包含项目的各种配置文件。
• lib: 存储项目的主要模块和类。
• public: 公共文件目录，通常包含静态文件如HTML页面、CSS和JavaScript文件。
• spec: 测试目录，包含项目的单元测试和功能测试。
• vendor: 第三方库目录，通常用于存放项目依赖的第三方代码。

2. 项目的启动文件介绍

项目的启动主要依赖于 config.ru 文件和 config/boot.rb 文件。

config.ru 文件

这是一个Rack配置文件，它定义了如何处理传入的HTTP请求。内容如下：

# This file is used by Rack-based servers to start the application.

require ::File.expand_path('../config/environment', __FILE__)
run Sapphire::Application

config/boot.rb 文件

这个文件负责加载项目环境和依赖库。它的内容可能如下：

# Set up the environment
require 'rubygems'

# Load the Rails application
require File.expand_path('..', __FILE__)

# Initialize the Rails application
Sapphire::Application.initialize!

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

config/database.yml

这个文件用于配置数据库连接信息，如下：

development:
  adapter: sqlite3
  database: db/development.sqlite3
  pool: 5
  timeout: 5000

test:
  adapter: sqlite3
  database: db/test.sqlite3
  pool: 5
  timeout: 5000

production:
  adapter: postgresql
  encoding: unicode
  pool: 5
  timeout: 5000
  # ...其他生产环境配置

config/routes.rb

这个文件定义了应用的路由规则，如下：

Sapphire::Application.routes.draw do
  # Define your application routes per the DSL available in https://guides.rubyonrails.org/routing.html
  root 'home#index'
  # ...其他路由规则
end

以上就是Sapphire项目的目录结构、启动文件和配置文件的介绍。按照这些指南，您可以开始搭建和运行Sapphire项目。