Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swordjs/sword-framework
A small and flexible for serverless nodejs framework ๐
https://github.com/swordjs/sword-framework
aws cloudflare nodejs serverless serverless-framework serverless-functions serverless-plugin typescript unicloud
Last synced: 14 days ago
JSON representation
A small and flexible for serverless nodejs framework ๐
- Host: GitHub
- URL: https://github.com/swordjs/sword-framework
- Owner: swordjs
- Created: 2022-02-01T11:41:40.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-01T15:50:40.000Z (over 1 year ago)
- Last Synced: 2024-10-19T06:22:40.435Z (27 days ago)
- Topics: aws, cloudflare, nodejs, serverless, serverless-framework, serverless-functions, serverless-plugin, typescript, unicloud
- Language: TypeScript
- Homepage:
- Size: 10.6 MB
- Stars: 25
- Watchers: 2
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
## Sword.js
[ไธญๆ่ฏดๆ](https://github.com/swordjs/sword-framework/tree/master/docs/README-CN.md) / [ไธญๆๆๆกฃ](https://www.yuque.com/mlgrgm/lrf0ra/af4ngt) /
[Unicloud ๅนณๅฐ](https://github.com/swordjs/sword-framework/tree/master/docs/READEME-DCLOUD-CN.md)
This is the first serverless framework in [sword.org](https://github.com/swordjs) 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
```bash
npm i @swordjs/sword-framework
```
We highly recommend you install the CLI toolkits to global, so you can use them in your project easily.
```bash
npm i @swordjs/sword-framework-cli -g
```
## Init template
You can use the CLI toolkit to init a new project, the template from [here](https://github.com/swordjs/sword-framework/tree/master/example)
```bash
sword init
```
## Start
```bash
# (server platform)
npm run dev
# (unicloud platform)
npm run dev:unicloud
# or
npm run build
```
## SwordJS - Vscode extension
[swordjs-Vscode extension](https://marketplace.visualstudio.com/items?itemName=swordjs.framework-helper)
## 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