Roguelike-Celebration/azure-mud 项目使用教程

Roguelike-Celebration/azure-mud 项目使用教程

azure-mud 项目地址: https://gitcode.com/gh_mirrors/az/azure-mud

1. 项目目录结构及介绍

azure-mud 项目是一个基于 TypeScript 和 React 的文本在线社交聊天空间，项目目录结构如下：

• admin.html: 管理页面模块文件
• deployWebhook.cjs: 部署 Webhook 的脚本文件
• favicon.png: 网站图标文件
• index.html: 项目入口 HTML 文件
• lintLinks.ts: 链接检查 TypeScript 文件
• map.monopic: 地图单张图片文件
• map2021.psci: 地图配置文件
• .deployment: 部署相关配置文件
• .env.sample: 环境变量示例文件
• .eslintrc.cjs: ESLint 配置文件
• .gitignore: Git 忽略文件
• .npmrc: npm 配置文件
• .nvmrc: Node.js 版本管理文件
• CNAME: 域名指向文件
• LICENSE: 开源协议文件
• README.md: 项目说明文件
• server: 后端代码目录
• src: 前端代码目录
• style: 样式文件目录

每个目录和文件都有其特定的作用，例如 server 目录包含了后端代码，src 目录包含了前端代码，.env.sample 是一个环境变量的示例文件，用于配置项目所需的各项参数。

2. 项目的启动文件介绍

项目的前端启动主要通过 package.json 文件中的脚本实现：

• npm run dev: 启动本地开发环境，默认监听 http://localhost:1234/index.html 地址。
• npm run build: 构建项目，生成可用于生产的打包文件。

前端代码的入口文件是 src 目录下的 index.tsx，它使用 React 和 Flux 架构来构建用户界面。

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• .env.sample: 这是一个环境变量配置文件示例，用于本地开发。在实际部署时，需要创建一个 .env 文件，并将 .env.sample 中的变量复制到 .env 文件中，并根据实际情况进行配置。

环境变量包括但不限于以下内容：

• REACT_APP_API_URL: 后端 API 的 URL 地址。
• REACT_APP_FIREBASE_API_KEY: Firebase 认证 API 密钥。
• REACT_APP_AUTH_DOMAIN: Firebase 认证域名。
• 其他与 Firebase、Azure 以及其他服务相关的配置。

正确配置这些环境变量是确保项目正常运行的关键。在部署到生产环境时，这些环境变量通常通过 GitHub Secrets 或其他环境配置服务进行管理。

azure-mud 项目地址: https://gitcode.com/gh_mirrors/az/azure-mud