Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 4.05 KB

File metadata and controls

109 lines (73 loc) · 4.05 KB

Sword.js

中文文档 / Unicloud 平台

这是 Sword 团队内部沉淀的第一个云函数框架,毫无疑问它完全是基于TypeScript开发的。除了 framework 核心程序之外,它为开发者提供了开箱即用的开发套件,使之能够开 发serverless应用像写普通的 nodejs 程序一样简单。你可以使用它开发各个厂商的 serverless 应用,比如 AWS,Aliyun,Tencent,Dcloud...

特性

  • ❤️ 完全拥抱TypeScript
  • 🐮 支持跨平台: Server/阿里云/腾讯云/Cloudflare/AWS/Unicloud
  • 🕷️ 基于文件系统的路由
  • 🥷 开箱即用的开发套件
  • 📖 TS 运行时类型校验
  • 📃 生成 API 文档,兼容 markdown 以及 openapi3.0
  • 😍 完全 Hook 的写法与设计
  • 🧩 Vscode 插件快速提升 API 开发效率

平台

平台 进度
Server
Unicloud
Woker ⚠️
阿里云 ⚠️
腾讯云 ⚠️
AWS ⚠️

安装

npm i @swordjs/sword-framework

我们非常建议你将 cli 脚手架安装到全局,这样就能够方便的使用了。

npm i @swordjs/sword-framework-cli -g

初始化

你可以更方便的初始化一个项目,它的初始化功能是由 cli 提供的,模板是从这里获取的。

sword init

使用

# (server platform)

npm run dev

# (unicloud platform)

npm run dev:unicloud

# or

npm run build

SwordJS - Vscode 插件

swordjs-Vscode extension

为什么要使用 Sword?

我们希望这款小框架是你手中的剑,它能够开箱即用,能够胜任你的大部分 serverless 开发场景,这款框架的实现难度很低,但是由于它的精心设计,使用的成本也非常低。而且它 可以无痛地让你在不同场景切换,只因为它的跨平台实现都是可插拔插件。

我相信,多说无用,只有尝试了才知道这款框架到底有多香,我准备了一个在线 demo,你 可以在这里看到它的用法 ( 但是云端环境运行不了,肯定不是我的锅 😄 )。

同样的,你也可以关注我的bilibili 频道,我会在频道里面更新这款框架的使用方法。

联系我们

友情开源项目

秋云ucharts跨端图表库

赞助

剑指题解团队不需要捐助,如何你觉得这个 repo 对你有用的话,你可以 star 支持一下我们,并且推广更多人使用 Sword。如果你真的想要赞助,那么就以我们的名义(剑指题解团 队)捐一笔款吧,你可以向中国红十字会-在线捐助

我们的服务号