Skip to content

Commit

Permalink
docs: add Bun to supported runtime
Browse files Browse the repository at this point in the history
  • Loading branch information
@Romakita
Romakita committed Dec 28, 2023
1 parent 8113e17 commit 578ae54
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 13 deletions.
Binary file added docs/.vuepress/public/bun.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/nodejs.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/swc.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 26 additions & 10 deletions docs/getting-started/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,22 @@ all the right tools to developers so that they are quickly productive.
Ts.ED tends towards the same objective which is to achieve better productivity while remaining easy to understand.
To achieve this, Ts.ED provides out-of-the-box an application architecture, highly testable, scalable and maintainable.

## Runtime support

Here are the runtime support provided by Ts.ED:

<div class="table-features">

| Runtime | |
| ----------------- | ----------------------------------------------------- |
| Node.js | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| Node.js + Babel | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| Node.js + Webpack | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| Node.js + SWC | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| Bun.js | <img src="../assets/valid.svg" width="15" alt="yes"/> |

</div>

## Platform features support

Here are the features list provided by Ts.ED and the compatibility with the different platforms:
Expand All @@ -79,8 +95,8 @@ Here are the features list provided by Ts.ED and the compatibility with the diff
| [JsonMapper](/docs/json-mapper.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| [Middlewares](/docs/middlewares.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> |
| [Pipes](/docs/pipes.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> |
| [Interceptors](/docs/interceptors.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| [Authentication](/docs/authentication.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> |
| [Interceptors](/docs/interceptors.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| [Authentication](/docs/authentication.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> |
| [Hooks](/docs/hooks.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> |
| [Exceptions](/docs/exceptions.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/invalid.svg" width="15" alt="no"/> |
| [Logger](/docs/logger.md) | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> | <img src="../assets/valid.svg" width="15" alt="yes"/> |
Expand Down Expand Up @@ -142,8 +158,8 @@ By using the CLI, you will be able to choose between different options to genera
- OIDC,
- Testing (Jest/Mocha),
- Linter (Eslint, prettier),
- Bundler (Babel/Webpack),
- The Package manager: NPM, Yarn or PNPM
- The runtime: Node.js, Node.js + Babel, Node.js + Webpack, Node.js + SWC, Bun
- The Package manager: NPM, Yarn, PNPM, Bun

::: tip
By default, it's recommended to select the following options: Express, Ts.ED (convention), Swagger, Jest and Eslint + prettier.
Expand Down Expand Up @@ -173,12 +189,12 @@ To prevent errors, fix the version for each Ts.ED packages:
```json
{
"dependencies": {
"@tsed/common": "6.10.0",
"@tsed/di": "6.10.0",
"@tsed/core": "6.10.0",
"@tsed/exceptions": "6.10.0",
"@tsed/plaftorm-express": "6.10.0",
"@tsed/swagger": "6.10.0"
"@tsed/common": "7.53.0",
"@tsed/di": "7.53.0",
"@tsed/core": "7.53.0",
"@tsed/exceptions": "7.53.0",
"@tsed/plaftorm-express": "7.53.0",
"@tsed/swagger": "7.53.0"
}
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/start-with-cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ You can select different options to generate your first application:
- OIDC,
- Testing (Jest/Mocha),
- Linter (Eslint, prettier),
- Bundler (Babel/Webpack),
- The Package manager: NPM, Yarn or PNPM
- The runtime: Node.js, Node.js + Babel, Node.js + Webpack, Node.js + SWC, Bun
- The Package manager: NPM, Yarn, PNPM, Bun

::: tip
By default, it's recommended to select the following options: Express, Ts.ED (convention), Swagger, Jest and Eslint + prettier.
Expand Down
11 changes: 10 additions & 1 deletion docs/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ sponsors:
src: /partners/schnell.svg
showContent: false
frameworks:
- title: Node.js
href: https://nodejs.org/
src: /nodejs.png
- title: Bun
href: https://bun.sh/
src: /bun.png
- title: TypeScript
href: https://www.typescriptlang.org/
src: /typescript.png
Expand All @@ -100,6 +106,9 @@ frameworks:
- title: Webpack
href: https://webpack.js.org/
src: /webpack.svg
- title: SWC
href: https://swc.rs/
src: /swc.png
- title: AJV
href: /tutorials/ajv.html
src: https://ajv.js.org/img/ajv.svg
Expand Down Expand Up @@ -133,7 +142,7 @@ frameworks:
- title: Nexus
href: /tutorials/graphql-nexus.html
src: /nexus.png
- title: Nexus
- title: GraphQL WS
href: /tutorials/graphql-ws.html
src: /graphql-ws.png
- title: Socket.io
Expand Down

0 comments on commit 578ae54

Please sign in to comment.