Step 1: Initialization

Welcome to the tutorial of the Tymber framework!

In this tutorial, we will build a classic TODO application while taking a tour of the features provided by the framework.

Prerequisites

For this tutorial, you will need either Node.js (v24 or higher) or Bun.

Scaffolding

Create a new directory

In a terminal, run the following command:

mkdir my-todo-app && cd my-todo-app

Initialize the `package.json` file

npm init --init-type=module -y

bun init -y

Install the dependencies

npm install @tymber/core @tymber/sqlite

bun add @tymber/core @tymber/sqlite

tip

As you can see, this tutorial uses the SQLite database but Tymber also supports other databases such as PostgreSQL.

Install the dependencies for development

npm install -D typescript tsx @types/node @tsconfig/node24 @tymber/client

bun add -D typescript @types/node @tsconfig/node24 @tymber/client

Initialize the `tsconfig.json` file

Create a tsconfig.json file with the following content:

tsconfig.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@tsconfig/node24/tsconfig.json",
  "compilerOptions": {
    "outDir": "dist",
    "verbatimModuleSyntax": true
  },
  "include": [
    "src/**/*.ts"
  ]
}

Create the module

A Tymber application can be split into modules. For this tutorial, we will create a single module named TodoModule:

src/module.ts
import { type Module } from "@tymber/core";
import { join } from "node:path";

export const TodoModule: Module = {
  name: "my-todo-app",
  version: "0.0.1",
  assetsDir: join(import.meta.dirname, "..", "assets"),

  init(app) {
    // register components here (services, repositories, endpoints, etc.)
  }
};

tip

Tymber also provides several first-party modules that you can include in your application:

Package	Usage
`@tymber/admin`	Admin dashboard
`@tymber/user`	User management
`@tymber/config`	Configuration management
`@tymber/openapi`	OpenAPI console

Create the entrypoint of your application

Create an entrypoint.ts file in the src/ directory with the following content:

src/entrypoint.ts
import { open } from "sqlite";
import sqlite3 from "sqlite3";
import { SQLiteDB } from "@tymber/sqlite";
import { App, toNodeHandler } from "@tymber/core";
import { createServer } from "node:http";
import { TodoModule } from "./module.js";

async function main() {
  const dbFile = await open({
    filename: "/tmp/my-todo-app.db",
    driver: sqlite3.Database,
  });

  const db = new SQLiteDB(dbFile);

  const app = await App.create({
    components: [db],
    modules: [TodoModule],
  });

  const httpServer = createServer(toNodeHandler(app.fetch));

  httpServer.listen(8080);
}

main().catch(console.error);

src/entrypoint.ts
import { open } from "sqlite";
import sqlite3 from "sqlite3";
import { SQLiteDB } from "@tymber/sqlite";
import { App } from "@tymber/core";
import { TodoModule } from "./module.js";

const dbFile = await open({
  filename: "/tmp/my-todo-app.db",
  driver: sqlite3.Database,
});

const db = new SQLiteDB(dbFile);

const app = await App.create({
  components: [db],
  modules: [TodoModule],
});

export default {
  port: 8080,
  fetch: app.fetch,
};

You can then start the application with:

npx tsx src/entrypoint.ts

bun src/entrypoint.ts

Ending note

That's it for the scaffolding! You should now have the following directory structure:

my-todo-app/
├── package.json
├── src/
│   ├── entrypoint.ts
│   └── module.ts
└── tsconfig.json

Prerequisites​

Scaffolding​

Create a new directory​

Initialize the package.json file​

Install the dependencies​

Install the dependencies for development​

Initialize the tsconfig.json file​

Create the module​

Create the entrypoint of your application​

Ending note​