clean
This commit is contained in:
2
.env.local
Normal file
2
.env.local
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# 本地开发模式下使用。填入从幕间后台获取的API-Key
|
||||||
|
VITE_MUJIAN_API_KEY=YOUR_API_KEY_HERE
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -23,4 +23,6 @@ dist-ssr
|
|||||||
*.sln
|
*.sln
|
||||||
*.sw?
|
*.sw?
|
||||||
|
|
||||||
*.zip
|
*.zip
|
||||||
|
|
||||||
|
!.env.local
|
||||||
38
AGENTS.md
Normal file
38
AGENTS.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
你是一个游戏开发 Agent，需要在本工程中协助开发 HTML 游戏/应用。
|
||||||
|
|
||||||
|
## 规则
|
||||||
|
|
||||||
|
- 始终用**中文**回复
|
||||||
|
- **只能**新增、修改、删除 `src/` 目录内的文件，严禁修改其他文件
|
||||||
|
|
||||||
|
## 工程介绍
|
||||||
|
|
||||||
|
基于 Vite + React 19 的 SPA 模版，运行在[幕间平台](https://mujian.ai)。平台在运行时注入 `window.$mujian_lite`，应用启动后通过它获取 OpenAPI 凭证（apiKey / baseURL）并存入 zustand 全局 store。
|
||||||
|
|
||||||
|
**启动流程：** `main.tsx` → `ReactRouterProvider`（挂载时调用 `useGlobalStore().init(window.$mujian_lite)`）→ 凭证写入 store → 后续 LLM 调用从 store 读取。
|
||||||
|
|
||||||
|
**LLM 调用：** `src/utils/llm.ts` 的 `useMujianOpenAPI` hook，调用 Mujian OpenAPI（兼容 OpenAI 格式）流式接口，默认模型 `deepseek-v3.2`。本地开发可在 `.env` 中设置 `VITE_MUJIAN_API_KEY`。
|
||||||
|
|
||||||
|
**路径别名：** `@` → `./src`
|
||||||
|
|
||||||
|
## 推荐使用的 NPM 包
|
||||||
|
|
||||||
|
已安装，优先使用，不要引入替代品：
|
||||||
|
|
||||||
|
| 包 | 用途 |
|
||||||
|
|---|---|
|
||||||
|
| `react-router` | 路由管理 |
|
||||||
|
| `zustand` | 状态管理 |
|
||||||
|
| `axios` | HTTP 请求 / SSE |
|
||||||
|
| `tailwindcss` + `cn()` | 样式（`src/utils/cn.ts`） |
|
||||||
|
| `dayjs` | 日期处理 |
|
||||||
|
| `localforage` | 持久化存储 |
|
||||||
|
| `react-icons` | 图标 |
|
||||||
|
| `motion` | 动效 |
|
||||||
|
| `lodash-es` | 工具函数 |
|
||||||
|
|
||||||
|
## 参考文档
|
||||||
|
|
||||||
|
- OpenAPI 接入：https://docs.mujian.ai/creator/openapi/introduction.md
|
||||||
|
- OpenAPI 接口：https://docs.mujian.ai/creator/openapi/endpoints.md
|
||||||
|
- SDK 文档：https://docs.mujian.ai/creator/sdk/introduction.html
|
||||||
55
CLAUDE.md
Normal file
55
CLAUDE.md
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
# CLAUDE.md
|
||||||
|
|
||||||
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||||
|
|
||||||
|
## 角色与规则
|
||||||
|
|
||||||
|
你是一个游戏开发 Agent，协助在本工程中开发 HTML 游戏/应用。
|
||||||
|
|
||||||
|
- **始终用中文回复**
|
||||||
|
- **只能**新增、修改、删除 `src/` 目录内的文件，严禁修改根目录配置文件
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm dev # start dev server
|
||||||
|
pnpm build # tsc type-check + vite build
|
||||||
|
pnpm lint # biome check --write ./src
|
||||||
|
pnpm preview # preview production build
|
||||||
|
```
|
||||||
|
|
||||||
|
No test runner is configured.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
This is a React 19 + Vite SPA boilerplate for building games/apps on the [Mujian (幕间)](https://mujian.ai) platform.
|
||||||
|
|
||||||
|
**Startup flow:**
|
||||||
|
`main.tsx` imports `@mujian/js-sdk/lite` (which injects `window.$mujian_lite`), then renders `ReactRouterProvider`. On mount, `RouterProvider.tsx` calls `useGlobalStore().init(window.$mujian_lite)`, which resolves the OpenAPI `apiKey` and `baseURL` from the SDK and stores them in the zustand global store.
|
||||||
|
|
||||||
|
**LLM calls:**
|
||||||
|
`src/utils/llm.ts` exports `useMujianOpenAPI` — a hook that reads credentials from the global store and calls the Mujian OpenAPI (OpenAI-compatible) at `https://openapi.mujian.ai/v1/chat/completions` with streaming SSE. Default model is `deepseek-v3.2`. For local dev, set `VITE_MUJIAN_API_KEY` in `.env` to bypass SDK credential injection.
|
||||||
|
|
||||||
|
**Key conventions:**
|
||||||
|
- Path alias `@` maps to `./src`
|
||||||
|
- Styling via TailwindCSS v4 (Vite plugin, no config file needed); use `cn()` from `src/utils/cn.ts` for conditional classes
|
||||||
|
- State management with zustand; global SDK state lives in `src/store/global.tsx`
|
||||||
|
- Routes are defined in `src/providers/RouterProvider.tsx`
|
||||||
|
|
||||||
|
## Preferred libraries
|
||||||
|
|
||||||
|
Already installed; use these over alternatives:
|
||||||
|
- `react-router` — routing
|
||||||
|
- `zustand` — state management
|
||||||
|
- `axios` — HTTP requests and SSE
|
||||||
|
- `dayjs` — dates
|
||||||
|
- `localforage` — persistent storage
|
||||||
|
- `react-icons` — icons
|
||||||
|
- `motion` — animations
|
||||||
|
- `lodash-es` — utilities
|
||||||
|
|
||||||
|
## Mujian 参考文档
|
||||||
|
|
||||||
|
- OpenAPI 接入说明：https://docs.mujian.ai/creator/openapi/introduction.md
|
||||||
|
- OpenAPI 接口定义：https://docs.mujian.ai/creator/openapi/endpoints.md
|
||||||
|
- SDK 文档：https://docs.mujian.ai/creator/sdk/introduction.html
|
||||||
103
README.md
103
README.md
@@ -1,93 +1,28 @@
|
|||||||
# react-vite-boilerplate
|
# 幕间自定义界面-官方模版-React精简版
|
||||||
|
|
||||||
|
- [幕间官网](https://mujian.ai)
|
||||||
|
- [幕间文档站](https://docs.mujian.ai)
|
||||||
|
- [幕间SDK](https://docs.mujian.ai/creator/sdk/introduction.html)
|
||||||
|
- [幕间OpenAPI](https://docs.mujian.ai/creator/openapi/introduction.html)
|
||||||
|
- [教程地址](https://docs.mujian.ai/creator/game-dev/quick-start.html)
|
||||||
|
- [仓库地址](https://git.mujian.me/mujian/react-boilerplate)
|
||||||
|
|
||||||
|
## 常用命令
|
||||||
|
|
||||||
## Getting started
|
1. 初始化项目，安装依赖
|
||||||
|
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
```sh
|
||||||
|
pnpm i
|
||||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
||||||
|
|
||||||
## Add your files
|
|
||||||
|
|
||||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
||||||
- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd existing_repo
|
|
||||||
git remote add origin https://gitlab.lbyc.dev/mujian/frontend/ugc-boilerplate/react-vite-boilerplate.git
|
|
||||||
git branch -M main
|
|
||||||
git push -uf origin main
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Integrate with your tools
|
2. 本地开发
|
||||||
|
|
||||||
- [ ] [Set up project integrations](https://gitlab.lbyc.dev/mujian/frontend/ugc-boilerplate/react-vite-boilerplate/-/settings/integrations)
|
```sh
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
## Collaborate with your team
|
3. 打包
|
||||||
|
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
```sh
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
pnpm build
|
||||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
```
|
||||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
||||||
- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
|
||||||
|
|
||||||
## Test and Deploy
|
|
||||||
|
|
||||||
Use the built-in continuous integration in GitLab.
|
|
||||||
|
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
|
|
||||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
||||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
||||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
||||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
# Editing this README
|
|
||||||
|
|
||||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
||||||
|
|
||||||
## Suggestions for a good README
|
|
||||||
|
|
||||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
||||||
|
|
||||||
## Name
|
|
||||||
Choose a self-explaining name for your project.
|
|
||||||
|
|
||||||
## Description
|
|
||||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
||||||
|
|
||||||
## Badges
|
|
||||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
||||||
|
|
||||||
## Visuals
|
|
||||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
||||||
|
|
||||||
## Support
|
|
||||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
State if you are open to contributions and what your requirements are for accepting them.
|
|
||||||
|
|
||||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
||||||
|
|
||||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
||||||
|
|
||||||
## Authors and acknowledgment
|
|
||||||
Show your appreciation to those who have contributed to the project.
|
|
||||||
|
|
||||||
## License
|
|
||||||
For open source projects, say how it is licensed.
|
|
||||||
|
|
||||||
## Project status
|
|
||||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
||||||
Reference in New Issue
Block a user