closes #5
This commit is contained in:
parent
0429516164
commit
e0c65a1517
7 changed files with 579 additions and 0 deletions
62
README.md
Normal file
62
README.md
Normal file
|
@ -0,0 +1,62 @@
|
|||
# STARSET Mirror 项目主页
|
||||
|
||||
直接访问: https://mirror.starset.fans
|
||||
|
||||
## 环境要求
|
||||
|
||||
- Node.js (推荐 v18+)
|
||||
- pnpm (推荐使用 pnpm 作为包管理器)
|
||||
|
||||
## 快速开始
|
||||
|
||||
1. 克隆仓库
|
||||
```bash
|
||||
git clone https://git.owu.one/starset-mirror/homepage
|
||||
cd homepage
|
||||
```
|
||||
|
||||
2. 安装依赖
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. 启动开发服务器
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
4. 构建生产版本
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
homepage
|
||||
├── data/ # 内容文件
|
||||
│ ├── zh-CN/ # 简体中文数据
|
||||
│ ├── zh-TW/ # 繁体中文数据
|
||||
│ └── en-US/ # 英文数据
|
||||
├── src/ # 源代码
|
||||
├── public/ # 静态资源
|
||||
├── docs/ # 文档
|
||||
└── scripts/ # 构建和工具脚本
|
||||
```
|
||||
|
||||
## 贡献指南
|
||||
|
||||
参见 `docs` 目录中的 [CONTRIBUTING.md](docs/zh-CN/CONTRIBUTING.md) 了解如何参与项目。
|
||||
|
||||
## 许可
|
||||
|
||||
本项目的所有内容与文档(`/data`与`/docs`)遵循 CC BY-NC-SA 4.0 协议。
|
||||
|
||||
本项目的源代码遵循 AGPL 3.0 协议。
|
||||
|
||||
## 联系我们
|
||||
|
||||
如果你有任何问题或建议,欢迎通过以下方式联系我们:
|
||||
|
||||
- 提交 Issue
|
||||
- [https://mirror.starset.fans/about](https://mirror.starset.fans/about)
|
Loading…
Add table
Add a link
Reference in a new issue