README.md

YunLiuCraft开源官网

注意项目目前还在开发阶段 有bug可以发起issue

所用到的工具&网站

本项目使用 + 编写
使用FontAwesome作为网页图标(部分)
使用markdown-it作为Rule页面的Markdown渲染器
使用VueToastNotification作为Toast(消息提醒)插件
使用minotar.net获取玩家面部图片
使用NProgress作为加载进度条
使用Vue3-Lazyload使图片懒加载

ps:点击图片或者超链接即可进入对应网站

功能

• 主页介绍
• 规则/协议页面 Markdown文件渲染
• 封禁页面(目前仅支持上传banned-players.json解析)
• 404页面
• 反馈页面(正在加紧制作中)

指令解析 (基于npm run)

1. build : 构建
2. dev : 开发预览
3. preview : 构建预览(需要先使用build构建完成后才能使用构建预览)
4. ver : 将版本号写入环境变量中(版本号就是commit id的前七位)
5. clean : 删除dist文件夹

部署

• 安装 node.js 环境

  node > 16.16.0
  npm > 8.15.0

• 然后以 管理员权限 运行 cmd 终端，并 cd 到 项目根目录

• 在 终端 中输入：

# 安装依赖(也可使用yarn)
npm install

# 预览(yarn dev)
npm run dev

# 构建(yarn build)
npm run build

构建完成后，静态资源会在 dist 目录 中生成，可将 dist 文件夹下的文件上传至服务器，也可使用 Vercel 等托管平台一键导入并自动部署

声明

本仓库中的代码注释较少 如有难以理解的语句可以发起issues
一切开发旨在学习，请勿用于非法用途

本项目遵循Apache License 2.0开源协议
网站是部署在vercel上的所以里面的一些关于vercel的东西可以不管:-)