Rust Web Starter 项目教程

Rust Web Starter 项目教程

rust-web-starterRust (Rocket & Diesel) + React (w/ Typescript) + PostgreSQL starter pack. Currently serves my need for a nice Dev Environment.项目地址:https://gitcode.com/gh_mirrors/ru/rust-web-starter

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

rust-web-starter/
├── api_server/
│   ├── src/
│   │   ├── main.rs
│   │   └── ...
│   ├── Cargo.toml
│   └── ...
├── web/
│   ├── public/
│   ├── src/
│   │   ├── index.tsx
│   │   └── ...
│   ├── package.json
│   └── ...
├── LICENSE
├── README.md
└── docker-compose.yml

目录结构介绍

• api_server/: 后端代码目录，使用 Rust 编写，主要框架为 Rocket 和 Diesel。

  • src/: 包含后端的主要源代码文件。
    • main.rs: 后端的主入口文件。
  • Cargo.toml: Rust 项目的配置文件，定义了项目的依赖和元数据。

• web/: 前端代码目录，使用 React 和 TypeScript 编写。

  • public/: 存放前端的静态资源文件。
  • src/: 包含前端的主要源代码文件。
    • index.tsx: 前端的主入口文件。
  • package.json: 前端项目的配置文件，定义了项目的依赖和脚本。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的说明文档。

• docker-compose.yml: Docker 配置文件，用于定义和运行多容器 Docker 应用程序。

2. 项目的启动文件介绍

后端启动文件

• api_server/src/main.rs:
  • 这是后端的主入口文件，负责启动 Rocket 服务器并加载 Diesel 数据库连接。
  • 主要功能包括：
    • 初始化 Rocket 应用。
    • 配置 Diesel 数据库连接。
    • 定义路由和处理请求。

前端启动文件

• web/src/index.tsx:
  • 这是前端的主入口文件，负责渲染 React 应用到 HTML 页面。
  • 主要功能包括：
    • 初始化 React 应用。
    • 渲染应用到 index.html 中的根元素。

3. 项目的配置文件介绍

后端配置文件

• api_server/Cargo.toml:
  • 定义了 Rust 项目的依赖和元数据。
  • 主要内容包括：
    • 项目名称、版本和作者信息。
    • 依赖库的版本和路径。

前端配置文件

• web/package.json:
  • 定义了前端项目的依赖和脚本。
  • 主要内容包括：
    • 项目名称、版本和作者信息。
    • 依赖库的版本和路径。
    • 脚本命令，如 start、build 等。

Docker 配置文件

• docker-compose.yml:
  • 定义了多容器 Docker 应用程序的配置。
  • 主要内容包括：
    • 服务的定义，如后端服务和前端服务。
    • 网络和卷的配置。
    • 环境变量的设置。

通过以上配置文件和目录结构，可以快速启动和配置 Rust Web Starter 项目。

rust-web-starterRust (Rocket & Diesel) + React (w/ Typescript) + PostgreSQL starter pack. Currently serves my need for a nice Dev Environment.项目地址:https://gitcode.com/gh_mirrors/ru/rust-web-starter