Ibis 项目安装与使用教程

Ibis 项目安装与使用教程

ibis A federated online encyclopedia 项目地址: https://gitcode.com/gh_mirrors/ibis/ibis

1. 项目目录结构及介绍

Ibis 项目目录结构如下：

ibis/
├── assets/             # 静态资源文件，如图片、CSS、JavaScript 等
├── config/             # 配置文件
├── crates/             # Rust 工作空间，包含多个 crate
├── docker/             # Docker 相关文件
├── scripts/            # 脚本文件
├── .gitignore          # Git 忽略文件
├── .leptosfmt.toml     # Leptos 格式配置文件
├── .rustfmt.toml       # Rust 格式配置文件
├── .woodpecker.yml     # Woodpecker 配置文件
├── Cargo.lock          # Cargo 锁文件
├── Cargo.toml          # Cargo 配置文件
├── LICENSE             # 许可证文件
├── README.md           # 项目说明文件
└── config.toml        # 主配置文件

• assets/：存储静态资源文件，如图片、CSS、JavaScript 等。
• config/：包含项目配置文件。
• crates/：Rust 工作空间，包含项目的各个 crate（模块）。
• docker/：Docker 相关文件，用于容器化项目。
• scripts/：脚本文件，包含项目构建、启动等脚本。
• .gitignore：Git 忽略文件，指定 Git 不需要追踪的文件和目录。
• .leptosfmt.toml：Leptos 格式配置文件，用于配置 Leptos 代码格式。
• .rustfmt.toml：Rust 格式配置文件，用于配置 Rust 代码格式。
• .woodpecker.yml：Woodpecker 配置文件，用于配置持续集成。
• Cargo.lock：Cargo 锁文件，记录项目依赖的具体版本。
• Cargo.toml：Cargo 配置文件，定义项目信息和依赖。
• LICENSE：许可证文件，本项目使用 AGPL-3.0 许可证。
• README.md：项目说明文件，介绍项目功能和用法。
• config.toml：主配置文件，用于配置项目运行参数。

2. 项目的启动文件介绍

Ibis 项目的启动文件为 scripts/run.sh，内容如下：

#!/bin/bash

set -e

# 确保已经安装 PostgreSQL
if ! command -v psql >/dev/null; then
    echo "PostgreSQL 不在PATH中，请先安装 PostgreSQL"
    exit 1
fi

# 创建数据库和用户
psql -c "CREATE USER ibis WITH PASSWORD 'ibis' SUPERUSER;" -U postgres
psql -c "CREATE DATABASE ibis WITH OWNER ibis;" -U postgres

# 安装依赖
pnpm install

# 启动项目
cargo leptos watch

该脚本首先检查 PostgreSQL 是否已安装，然后创建数据库和用户，接着安装项目依赖，最后启动项目。

3. 项目的配置文件介绍

Ibis 项目的配置文件为 config.toml，内容如下：

[database]
user = "ibis"
password = "ibis"
host = "localhost"
port = 5432
dbname = "ibis"

[server]
host = "127.0.0.1"
port = 3000

配置文件中包含数据库和服务器设置：

• database：数据库配置，包括用户名、密码、主机、端口和数据库名称。
• server：服务器配置，包括主机和端口。

ibis A federated online encyclopedia 项目地址: https://gitcode.com/gh_mirrors/ibis/ibis