JSR 开源项目教程

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

JSR 项目的目录结构如下：

jsr/
├── api/
│   ├── src/
│   └── ...
├── frontend/
│   ├── src/
│   └── ...
├── github/
│   └── workflows/
├── terraform/
│   └── terraform_infra/
├── tools/
├── .gitignore
├── LICENSE
├── README.md
├── deno.json
├── deno.lock
├── docker-compose.yml
├── rust-toolchain.toml
└── ...

目录结构介绍

• api/: 包含项目的 API 实现，主要使用 Rust 语言编写。
  • src/: API 的主要代码文件。
• frontend/: 包含项目的前端实现，主要使用 Fresh 框架。
  • src/: 前端的主要代码文件。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• terraform/terraform_infra/: 包含 Terraform 的基础设施配置文件。
• tools/: 包含项目使用的各种工具和脚本。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• deno.json: Deno 项目的配置文件。
• deno.lock: Deno 项目的依赖锁定文件。
• docker-compose.yml: Docker Compose 配置文件，用于本地开发环境的启动。
• rust-toolchain.toml: Rust 工具链配置文件。

2. 项目的启动文件介绍

前端启动文件

前端的启动文件主要位于 frontend/src/ 目录下。主要的启动文件是 main.ts，它负责初始化前端应用并启动服务器。

// frontend/src/main.ts
import { start } from "fresh";
import routes from "./routes.ts";

await start(routes);

API 启动文件

API 的启动文件主要位于 api/src/ 目录下。主要的启动文件是 main.rs，它负责初始化 API 服务器并启动监听。

// api/src/main.rs
use api::run;

#[tokio::main]
async fn main() {
    run().await;
}

3. 项目的配置文件介绍

Deno 配置文件

Deno 项目的配置文件是 deno.json，它包含了项目的依赖和任务配置。

{
  "tasks": {
    "dev:frontend": "deno run --allow-net --allow-read --allow-env ./frontend/src/main.ts",
    "dev:api": "deno run --allow-net --allow-read --allow-env ./api/src/main.rs"
  },
  "importMap": "./import_map.json"
}

Docker Compose 配置文件

Docker Compose 配置文件是 docker-compose.yml，它用于定义本地开发环境的容器配置。

version: '3.8'
services:
  api:
    build: ./api
    ports:
      - "8080:8080"
  frontend:
    build: ./frontend
    ports:
      - "3000:3000"

Rust 工具链配置文件

Rust 工具链配置文件是 rust-toolchain.toml，它指定了项目使用的 Rust 版本。

[toolchain]
channel = "stable"

通过以上配置文件，可以方便地启动和管理 JSR 项目的开发环境。