https://github.com/typetron/framework
Typetron is a modern Node.js framework for building backend web apps with Typescript
https://github.com/typetron/framework
backend framework fresh modern nodejs typescript web
Last synced: about 2 months ago
JSON representation
Typetron is a modern Node.js framework for building backend web apps with Typescript
- Host: GitHub
- URL: https://github.com/typetron/framework
- Owner: typetron
- License: mit
- Created: 2019-09-22T19:16:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-13T10:13:47.000Z (3 months ago)
- Last Synced: 2025-08-08T23:46:24.476Z (2 months ago)
- Topics: backend, framework, fresh, modern, nodejs, typescript, web
- Language: TypeScript
- Homepage: http://typetron.org
- Size: 1.38 MB
- Stars: 29
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Support: Support/Array.ts
Awesome Lists containing this project
README
# Typetron
> **Note:** This project is a prototype in heavy development and not ready for production.
**[Typetron](https://typetron.org)** is a **modern web framework** built for Node.js, written in **Typescript**, that
allows you to build fully featured web applications.
Typetron is best suited for small sized to enterprise level apps.
Most of the core packages it uses were built from scratch in order to preserve the performance of the framework.
_(check [this tutorial](https://typetron.org/tutorials/blog) on how to get started with Typetron)_
### Prerequisites
- [NodeJs >=12 LTS](https://nodejs.org)
#### Features
Typetron aims to have all the features necessary for building any web app without the need for you
to search the internet for a package to use. Almost all the packages it has were built from scratch and are
available in the framework.
This was done to ensure that all the features you are using benefit from the latest language features.
Also, every package can be tuned for performance or updated in no time if needed.
##### Features List
[typetron.org](https://typetron.org/docs/)
##### Performance
Being built with packages created from scratch using the latest features of the language, Typetron comes with
excellent performance out of the box compared to other available frameworks.
##### Developer experience
Typetron's source code is built around developer's expectations: it is modern, clean and beautiful.
Also, the tools Typetron is providing are everything a developer needs to build his next awesome project.
##### Code sharing
A few years ago we wrote websites. Nowadays we write web applications. The web evolved alongside the tools we are
using. A typical web application is composed of at least two parts: a backend app and a frontend app.
This separation led to two different camps that have a very distinct line between them. Typetron provides tools to make
these two camps work together.
#### Source code examples
##### Entities
```ts
export class User extends Entity {
@PrimaryColumn()
id: number;
@Column()
email: string;
@Column()
name: string;
@Relation(() => Post, 'author')
posts: HasMany = [];
@Relation(() => Group, 'users')
group: BelongsTo;
}
```
##### Forms
```ts
export class UserForm extends Form {
@Field()
@Rules(
Required,
)
email: string;
@Field()
@Rules(
Required,
MinLength(5),
)
name: string;
@Field()
dateOfBirth: Date;
}
```
##### Controllers
```ts
@Controller('users')
export class UserController {
@Inject()
storage: Storage;
@AuthUser()
user: User;
@Get('me')
async me() {
return this.auth.user;
}
@Get()
async browse() {
return UserModel.from(User.get());
}
@Get(':User')
read(user: User) {
return user;
}
@Put(':User')
update(user: User, userForm: UserForm) {
return user.fill(userForm).save();
}
@Post()
create(userForm: UserForm) {
return User.create(userForm);
}
}
```
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.