目录

Spak 喵~ ✨

一只基于 Koishi 的全能框架的说!—— 炒鸡厉害的全能喵喵框架!(。>ω<。)ノ♡


呜喵~这是什么呀?(=ↀωↀ=)

Spak 是一只超级全能的小框架喵!它继承了 Koishi 的可爱基因(插件系统和依赖注入什么的),然后被咱 Spak Team 喂了神奇猫粮,长出了更多厉害的本领的说!

Spak 能干什么喵? (っ´ω`)ノ✨

  • 🎮 打包二进制应用 — 变成可以跑的喵!
  • 🏗️ 构建平台/引擎 — 想变成什么就变成什么!
  • 🌐 搭中心化/去中心化网络 — 网网相连的说!
  • 🖥️ 开游戏服务器 — 带大家一起玩!
  • 还有更多等着主人发掘的说~

咱 Spak 用的是 TypeScript,核心由这些可爱的包包组成:

包包名 是干什么的喵~
@spakjs/core 🧠 大脑核心的说!命令、中间件、i18n、权限都在这里~
@spakjs/cli 🎮 CLI 小帮手,spak start 就能跑起来!
@spakjs/loader 📂 配置文件加载器,读 YAML/JSON 什么的~
@spakjs/utils 🧰 工具箱,装满了小玩意喵!
@spakjs/i18n-utils 🌐 国际化,让全世界都能看懂的说!

还有可爱的小插件们:

  • @spakjs/plugin-server 🖥️ — 服务器服务
  • @spakjs/plugin-http 🌍 — HTTP/WebSocket 客户端
  • @spakjs/plugin-hmr 🔥 — 热重载,改完代码不用重启的说!

快速开始 喵!(>ω<)ノ

需要准备好这些喵~

  • Node.js >= 18
  • pnpm >= 8

第一步:把猫猫带回家~

# 把依赖都装好
pnpm install

# 构建所有包包,注册 spak 到全局
pnpm build

第二步:写个配置文件的说~

在项目根目录创建 spak.config.yml

name: my-spak-app
plugins:
  server:
  http:

第三步:启动!(=ↀωↀ=)✧

# 直接用默认配置启动喵
spak start

# 也可以指定配置文件
spak start ./path/to/spak.config.yml

开发模式喵~

# 开发模式(构建 + 全局链接)
pnpm dev

# 清理喵
pnpm clean

许可证

咱用的是 MIT License 喵~ 版权归 Spak Team 和 Shigma 所有地说!(=ↀωↀ=)


咕噜咕噜~如果主人想给 Spak 加新功能、修 bug,随时来找咱的说!咱会摇着尾巴陪主人一起干的喵!(。>ω<。)ノ✧

关于
106.0 KB
邀请码
    Gitlink(确实开源)
  • 加入我们
  • 官网邮箱:gitlink@ccf.org.cn
  • QQ群
  • QQ群
  • 公众号
  • 公众号

版权所有:中国计算机学会技术支持:开源发展技术委员会
京ICP备13000930号-9 京公网安备 11010802047560号