Fog Machine 项目安装与使用教程

Fog Machine 项目安装与使用教程

fog-machine Fog Machine is a 3rd party extension tool for the app Fog of World. 项目地址: https://gitcode.com/gh_mirrors/fog/fog-machine

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

Fog Machine 项目是一个为 Fog of World 应用开发的第三方扩展工具，其目录结构如下：

.
├── editor
    // 编辑器前端部分
├── frontend
    // 其他前端部分，包括主页和时光机
└── server
    // 后端部分，支持时光机

• editor: 存放编辑器的前端代码，用于可视化编辑 Fog of World 数据。
• frontend: 存放其他前端代码，包括项目主页和时光机的前端实现。
• server: 存放后端代码，为时光机提供后端服务。

2. 项目的启动文件介绍

前端启动

对于前端部分，我们使用 yarn 作为包管理工具。

• 安装依赖：yarn install
• 启动开发服务器：yarn start
• 进行代码检查：yarn run cicheck
• 自动修复代码风格问题：yarn run autofix

后端启动

对于后端部分，我们使用 cargo 来运行 Rust 语言编写的服务。

• 运行服务：cargo run

3. 项目的配置文件介绍

在开始运行项目前，需要正确设置环境变量。项目提供了一个示例配置文件 env.local.example，你可以将其重命名为 env.local 并在其中填写相应的配置信息。

对于前端和后端，配置文件的设置可能会有所不同，具体需要根据各自的 README 文档来进行相应配置。

确保所有部分的环境变量都设置正确后，就可以按照上述启动文件介绍的方式运行你的项目了。

fog-machine Fog Machine is a 3rd party extension tool for the app Fog of World. 项目地址: https://gitcode.com/gh_mirrors/fog/fog-machine