tsed

What it is

Ts.ED is a modern Node.js framework built with TypeScript. It offers a flexible structure with a fast learning curve, specifically designed to improve the developer experience. Ts.ED provides numerous decorators and guidelines to make your code more readable and less error-prone. It supports various platforms and tools, including Node.js/Bun.js, Express.js/Koa.js, CLI, and serverless architectures (e.g., AWS).

• Multi-platform: Easily build your server-side application using Express.js, Koa.js, CLI, or serverless platforms (e.g., AWS). It supports both Node.js and Bun.js runtimes. Learn more here.
• Configuration: Stop wasting time on configuration—your application comes preconfigured for a fast start! Try our CLI.
• Decorators: Use a wide range of decorators to structure your code, define routes, and implement methods with ease. Learn more here.
• Class-based: Define classes as Controllers, Models, Providers (DI), Pipes, and more, with JSON Schema and OpenAPI at the core of the framework.
• Testing: Testing is not optional—it's essential! Ts.ED includes built-in features to make testing your code simple and efficient. Learn more here.

Features

• Use our CLI to create a new project: https://tsed.dev/introduction/getting-started.html#installation
• Support TypeORM, Mongoose, GraphQL, Socket.io, Swagger-ui, Passport.js, etc...
• Define class as Controller,
• Define class as Service (IoC),
• Define class as Middleware and MiddlewareError,
• Define class as Json Mapper (POJ to Model and Model to POJ),
• Define root path for an entire controller and versioning your Rest API,
• Define as sub-route path for a method,
• Define routes on GET, POST, PUT, DELETE and HEAD verbs,
• Define middlewares on routes,
• Define required parameters,
• Inject data from query string, path parameters, entire body, cookies, session or header,
• Inject Request, Response, Next object from Express request,
• Template (View),
• Testing.

Links

• Board/Roadmap
• Documentation
• Guideline
• Create a platform adapter skill
• Tutorials
• Community Slack
• Support us
• Team

Getting started

See our getting started here to create new Ts.ED project or use our CLI

Overview

Server example

Here an example to create a Server with Ts.ED:

import {Configuration, Inject} from "@tsed/di";
import {PlatformApplication} from "@tsed/platform-http";
import "@tsed/platform-express";
import cookieParser from "cookie-parser";
import compress from "compress";
import methodOverride from "method-override";

@Configuration({
  port: 3000,
  middlewares: ["cookie-parser", "compression", "method-override", "json-parser", "urlencoded-parser"]
})
export class Server {}

To run your server, you have to use Platform API to bootstrap your application with the expected platform like Express.

import {$log} from "@tsed/logger";
import {PlatformExpress} from "@tsed/platform-express";
import {Server} from "./Server.js";

async function bootstrap() {
  try {
    $log.debug("Start server...");
    const platform = await PlatformExpress.bootstrap(Server);

    await platform.listen();
    $log.debug("Server initialized");
  } catch (er) {
    $log.error(er);
  }
}

bootstrap();

To customize the server settings see Configure server with decorator

Controller example

This is a simple controller to expose user resource. It use decorators to build the endpoints:

This is the beginning of the README. Read the rest at the original. Read the full README ↗