Tymber framework

Tymber is a batteries-included framework for building TypeScript applications.

Table of contents

• Documentation
• Getting started
  • Bun
    • Installation
    • Usage
  • Node.js
    • Installation
    • Usage
• Packages
• License

Documentation

https://tymber-framework.github.io/tymber/

Getting started

Bun

Installation

bun add @tymber/core @tymber/admin @tymber/postgres

Usage

import * as pg from "pg";
import { PostgresDB } from "@tymber/postgres";
import { App } from "@tymber/core";
import { AdminModule } from "@tymber/admin";

const pgPool = new pg.Pool({
  user: "postgres",
  password: "changeit",
});

const db = new PostgresDB(pgPool);

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

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

Node.js

Installation

npm i @tymber/core @tymber/admin @tymber/postgres

Usage

import * as pg from "pg";
import { PostgresDB } from "@tymber/postgres";
import { App, toNodeHandler } from "@tymber/core";
import { AdminModule } from "@tymber/admin";
import { createServer } from "node:http";

const pgPool = new pg.Pool({
  user: "postgres",
  password: "changeit",
});

const db = new PostgresDB(pgPool);

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

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

httpServer.listen(8080);

Packages

This repository contains the following packages:

Package	Description	Latest release
@tymber/client	Dependency-less client that can be used in a frontend project or for tests	0.1.0
@tymber/core	The internals of the framework	0.2.1
@tymber/admin	The admin module	0.1.0
@tymber/user	The user module	0.1.0
@tymber/postgres	The PostgreSQL module (DB & PubSubService components)	0.1.0
@tymber/sqlite	The SQLite module	0.1.0
@tymber/openapi	The OpenAPI module	0.1.0
@tymber/config	The config module	0.1.0

License

MIT