Skip to content

About

Quickly create an LSE mod that includes frontend (React) and backend.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

LeviLamina LSE Web React Template

这是一个用于快速创建包含前端(React)和后端的 LeviLamina LSE 网页的模板。旨在简化 Minecraft 服务器插件开发中 Web 功能的集成流程,提供标准化的全栈开发结构。

核心特性

  • 后端服务: 基于 Express 的 HTTP 服务器,支持 CORS,用于处理 API 请求。
  • 前端展示: 使用 React 和 TypeScript 构建的现代前端界面,提供了更好的开发体验和组件复用能力。
  • API 注册机制: 提供标准化的接口定义与注册流程,连接 LSE 引擎与 Web 服务。
  • 构建打包: 自动化将 TypeScript 后端代码打包为单文件 bundle,并处理前端静态资源。

技术栈

  • 后端: TypeScript, Node.js, Express.js
  • 前端: React, TypeScript
  • 构建工具: Rollup, Create React App
  • 其他: cors, archiver, winston, @levimc-lse/types

快速开始

  1. 克隆此模板仓库
  2. 安装依赖: npm install
  3. 开发模式: npm run dev
  4. 生产构建: npm run build
  5. 构建并打包为 Zip: npm run build:zip

开发模式

项目提供了多种开发模式以适应不同的开发需求:

  1. 仅后端开发模式: npm run dev

    • 监听后端文件变更并自动重新构建
    • 部署到Minecraft服务器
  2. 前端开发服务器: npm run dev:frontend

    • 启动React开发服务器,支持热重载
    • 无法连接到后端服务器

项目结构

  • src/: 源代码目录
    • api-register.ts: API 接口定义与注册中心
    • main.ts: 应用入口,负责初始化服务和注册 API
    • server.ts: Express 服务器配置与启动逻辑
  • frontend/: 前端代码目录
    • src/: React 开发目录
    • ...
  • script/: 构建与开发辅助脚本
    • build.cjs: 生产构建脚本
    • dev.cjs: 开发模式脚本
  • output/: 构建输出目录 (构建后生成)

开发说明

后端开发

后端代码位于 src/ 目录下,使用 TypeScript 编写。API 接口在 api-register.ts 中定义并通过 main.ts 注册。

前端开发

前端代码位于 frontend/ 目录下,使用 React 和 TypeScript 构建。遵循 Create React App 的标准目录结构。

许可证

MIT

About

Quickly create an LSE mod that includes frontend (React) and backend.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages