Sword.js

中文说明 / 中文文档 / Unicloud 平台

This is the first serverless framework in sword.org for nodejs. No doubt it is fully developed based on Typescript. Except for framework core, have a toolkit for developer, make it easy to use same as developing common nodejs application, you can use it develop different company serverless application, like AWS, Dcloud, Tencent, Alibaba, etc.

Features

• ❤️ Support typescript
• 🐮 Support plugin system
• 🕷️ Support file system routes
• 🥷 Out of the box toolkits for developer
• 📖 Runtime check on typescript
• 📃 Generate markdown or openapi3.0 api documentation
• 😍 Hooks api design
• 🧩 Vscode-extension for develop application better.

Platforms

platform	status
Server	✅
Unicloud	✅
Worker	⚠️
Alibaba	⚠️
Tencent	⚠️
AWS	⚠️

Install

npm i @swordjs/sword-framework

We highly recommend you install the CLI toolkits to global, so you can use them in your project easily.

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

Init template

You can use the CLI toolkit to init a new project, the template from here

sword init

Start

# (server platform)

npm run dev

# (unicloud platform)

npm run dev:unicloud

# or

npm run build

SwordJS - Vscode extension

swordjs-Vscode extension

Why should I use sword.js ?

We hope this little framework is like a sword in your hands. it can be out of the box, and can qualified your in large part of the serverless platforms. this framework development level is very low, but because of nice design, the use cost is very low yet.

I believe that it's useless to say more. Only after trying can we know how fragrant this framework is

Contact us (for Chinese🇨🇳)

Friend open source project

ucharts