43 lines
1.7 KiB
Markdown
43 lines
1.7 KiB
Markdown
<p align="center">
|
|
<a href="https://code.zeptotech.net/Sharkitek/Core">
|
|
<picture>
|
|
<img alt="Sharkitek logo" width="200" src="https://code.zeptotech.net/Sharkitek/Core/raw/branch/main/logo.svg" />
|
|
</picture>
|
|
</a>
|
|
</p>
|
|
<h1 align="center">
|
|
Sharkitek SRM
|
|
</h1>
|
|
|
|
<h4 align="center">
|
|
<a href="https://code.zeptotech.net/Sharkitek/SRM">Documentation</a> |
|
|
<a href="https://code.zeptotech.net/Sharkitek/SRM">Website</a>
|
|
</h4>
|
|
|
|
<p align="center">
|
|
TypeScript ORM for Sharkitek models
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img alt="Tests status" src="https://code.zeptotech.net/Sharkitek/SRM/badges/workflows/test.yaml/badge.svg?branch=main" />
|
|
<a href="https://bundlephobia.com/package/@sharkitek/srm" target="_blank">
|
|
<img alt="Bundle size" src="https://badgen.net/bundlephobia/minzip/@sharkitek/srm" />
|
|
</a>
|
|
<a href="https://www.npmjs.com/package/@sharkitek/srm" target="_blank">
|
|
<img alt="Latest release" src="https://badgen.net/npm/v/@sharkitek/srm" />
|
|
</a>
|
|
<a href="https://bundlephobia.com/package/@sharkitek/srm" target="_blank">
|
|
<img alt="Bundle size" src="https://badgen.net/bundlephobia/dependency-count/@sharkitek/srm" />
|
|
</a>
|
|
<img alt="Latest release" src="https://badgen.net/npm/types/@sharkitek/srm" />
|
|
</p>
|
|
|
|
## Introduction
|
|
|
|
Sharkitek is a lightweight Javascript / TypeScript library designed to ease development of models. Sharkitek SRM is an extension of Sharkitek, providing a simple ORM on top of Sharkitek.
|
|
|
|
```shell
|
|
yarn add @sharkitek/srm
|
|
```
|
|
|
|
With Sharkitek SRM, you define the architecture of your models by specifying their properties and their types. You also define how these properties are stored in database, which allows you to query, insert and update records.
|