Tuono项目使用教程

Tuono项目使用教程

tuono The react/rust fullstack framework 项目地址: https://gitcode.com/gh_mirrors/tu/tuono

1. 项目目录结构及介绍

Tuono项目是一个基于Rust和React的全栈Web框架，其目录结构如下：

• assets/: 存储静态资源，如图标、图片、样式表等。
• crates/: 包含Rust相关的包和依赖。
• devtools/: 存储开发工具相关配置。
• docker/: 存储Docker相关配置文件。
• e2e/: 端到端测试相关文件。
• examples/: 示例项目或组件。
• packages/: 存储项目中的JavaScript包。
• scripts/: 存储项目脚本，用于执行特定任务。
• .github/: 存储GitHub相关配置，如工作流、代码所有者等。
• .editorconfig/: EditorConfig配置文件，用于统一开发者的代码风格。
• .gitattributes/: Git属性配置文件，用于设置Git行为。
• .gitignore/: Git忽略文件，用于指定不需要提交到版本控制系统的文件。
• .npmrc：npm配置文件。
• .nvmrc：Node.js版本管理器配置文件。
• .prettierrc：Prettier配置文件，用于统一代码格式。
• .prettierignore：Prettier忽略文件。
• CODEOWNERS：代码所有者文件，用于指定代码的负责人。
• CODE_OF_CONDUCT.md：行为准则文件。
• CONTRIBUTING.md：贡献指南文件。
• Cargo.toml：Rust项目配置文件。
• LICENSE.md：项目许可证文件。
• README.md：项目说明文件。
• eslint.config.js：ESLint配置文件。
• package.json：npm项目配置文件。
• pnpm-lock.yaml：pnpm锁文件。
• pnpm-workspace.yaml：pnpm工作空间配置文件。
• renovate.json：Renovate配置文件，用于自动更新依赖。
• tsconfig.json：TypeScript配置文件。
• turbo.json：Turbo配置文件。

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• Cargo.toml：Rust的配置文件，定义了项目的依赖、构建脚本等信息。
• package.json：JavaScript的配置文件，定义了项目的依赖、脚本、入口点等。

要启动项目，你需要在项目根目录下执行以下命令：

cargo install tuono
tuono new [PROJECT_NAME]
npm install
tuono dev

这些命令会安装Tuono框架，创建一个新项目，安装JavaScript依赖，并启动开发环境。

3. 项目的配置文件介绍

以下是项目中的几个重要配置文件介绍：

• .gitignore：用于配置Git忽略规则，避免将不必要的文件提交到版本控制系统中。

# 编译产生的文件
target/

# 依赖项
vendor/

# 临时文件
*.sw?

# 日志文件
*.log*

# npm产生的文件
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# visual studio code目录
.vscode/

• tsconfig.json：TypeScript配置文件，用于配置TypeScript的编译选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "jsx": "react",
    "incremental": true,
    "moduleResolution": "node",
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src/**/*"]
}

• Cargo.toml：Rust项目的配置文件，以下是一个基本的配置示例。

[package]
name = "tuono"
version = "0.1.0"
edition = "2021"

[dependencies]
actix-web = "4.0"
actix-rt = "2.0"
serde = { version = "1.0", features = ["derive"] }

以上是Tuono项目的基本目录结构、启动文件和配置文件介绍。通过这些文件，你可以更好地理解项目结构，并开始开发自己的全栈Web应用。

tuono The react/rust fullstack framework 项目地址: https://gitcode.com/gh_mirrors/tu/tuono