Introduction

# Introduction

Ts.ED is a framework for building server-side and scalable applications for Node.js environment. It's built with TypeScript (opens new window) and uses classes (OOP), decorators and Functional programming to develop your application.

It uses Express.js (opens new window) HTTP server frameworks by default, but it's also possible to use Koa.js (opens new window) or Serverless (opens new window) as well.

Ts.ED provides a level of abstraction above these common Node.js frameworks (Express/Koa) with the Platform API but also exposes their APIs directly for the developer. It gives developers the freedom to use the myriad of third-party node modules which are available for the underlying platform.

# Philosophy

Node.js opened the possibility of making server applications with Javascript, allowing to pool front-end and back-end skills.

With this we have seen the birth of extraordinary projects like React.js (opens new window), Vue.js (opens new window), Angular (opens new window). Each of these projects bring their vision of a web application, but we have the same wish, to make the developer's life easier by providing 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.

# Platform features support

Here are the features list provided by Ts.ED and the compatibility with the different platforms:

Features Express.js Koa.js Serverless λ CLI
Controllers
(routing, nested, inheritance)		 yes yes yes no
Providers yes yes yes yes
Model & JsonSchema yes yes yes yes
JsonMapper yes yes yes yes
Middlewares yes yes no no
Pipes yes yes yes no
Interceptors yes yes yes yes
Authentication yes yes no no
Hooks yes yes yes yes
Exceptions yes yes yes no
Logger yes yes yes yes
Upload files yes yes no no
Serve files yes yes no no
Templating yes yes yes no
Validation yes yes yes no
Response Filters yes yes yes no
Cache yes yes
?
 no

# Platform plugins support

Here are the plugins provided by Ts.ED and the compatibility with the different platforms:

Features Express.js Koa.js Serverless λ CLI
Passport.js yes no no no
Prisma yes yes yes yes
TypeORM yes yes yes yes
Mongoose yes yes yes yes
IORedis yes yes yes yes
Objection.js yes yes yes yes
GraphQL yes no no no
Socket.io yes yes no no
Swagger yes yes no no
OIDC yes yes no no
Stripe yes yes
?
 no

# Installation

To get started, you can either scaffold the project with the Ts.ED CLI, or clone a starter project.

To scaffold the project with the CLI, run the following commands. This will create a new project directory, and populate the directory with the initial core Ts.ED files and supporting modules, creating a conventional base structure for your project. Creating a new project with the CLI is recommended for first-time users.

npm install -g @tsed/cli
tsed init .
1
2

By using the CLI, you will be able to choose between different options to generate your first application:

  • The web framework: Express.js / Koa.js
  • The convention project architecture: Ts.ED or Feature
  • The convention file styling: Ts.ED or Angular
  • The features:
    • Graphql,
    • Database,
    • Passport.js,
    • Socket.io,
    • Swagger,
    • OIDC,
    • Testing (Jest/Mocha),
    • Linter (Eslint, prettier),
    • Bundler (Babel/Webpack),
  • The Package manager: NPM, Yarn or PNPM

TIP

By default, it's recommended to select the following options: Express, Ts.ED (convention), Swagger, Jest and Eslint + prettier.

When all options are selected, the CLI will generate all files. When it's done, run one of this command:

yarn start
npm start
pnpm start
1
2
3

# Update dependencies

WARNING

If you have to upgrade Ts.ED dependencies, keep in mind this point:

It's really important to keep the same version for all @tsed/* (excepted @tsed/logger) packages. To prevent errors, fix the version for each Ts.ED packages:

{
  "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"
  }
}
1
2
3
4
5
6
7
8
9
10

# Project examples

Alternatively, you can check out one of these projects:

If none of previous solutions are satisfying maybe you are in these cases:

# What's next?

Now you can follow one of these links to develop your new application:

Last Updated: 2/5/2023, 1:16:22 PM

Configuration Controllers

Other topics