# Deepkit ORM Browser

```sh
npm install @deepkit/orm-browser
```

Deepkit ORM Browser 是一个 Web 应用程序，可用于浏览数据库 ORM schema、编辑内容
以及查看迁移变更。

它是 [Framework Debugger](https://deepkit.io/zh/documentation/framework.md) 的一部分，但也可以独立使用。


    ![](https://deepkit.io/assets/screenshots-orm-browser/content-editing.png)
    ![](https://deepkit.io/assets/screenshots-orm-browser/model-diagram.png)
    ![](https://deepkit.io/assets/screenshots-orm-browser/query.png)


## API reference of @deepkit/orm-browser

### serveOrmBrowser (function)

```typescript
(databases: Database[], config?: { port?: number; host?: string; }): Promise<void>
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/orm-browser/index.ts#L8

### OrmBrowserModule (class)

```typescript
export class OrmBrowserModule extends createModuleClass({
    config: Config
}) {
    databases: Database[];
    forDatabases(databases: Database[]): this;
    process();
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/orm-browser/src/module.ts#L10