---
name: typeorm
summary: "typeorm is an open-source TypeScript project with 36.5k GitHub stars. It is associated with active-record, cockroachdb, data-mapper, database. The repository is actively maintained, with recent commits."
language: TypeScript
license: MIT
repo: https://github.com/typeorm/typeorm
source: https://opensources.dev/resource/typeorm
health: 100
---

# typeorm

typeorm is an open-source TypeScript project with 36.5k GitHub stars. It is associated with active-record, cockroachdb, data-mapper, database. The repository is actively maintained, with recent commits.

# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```tsx
$ pnpm install
```

### Local Development

```tsx
$ pnpm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```tsx
$ pnpm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```tsx
$ USE_SSH=true pnpm deploy
```

Not using SSH:

```tsx
$ GIT_USER=<Your GitHub username> pnpm deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.