Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/foxifyjs/odin

Odin is an implementation of the Active Record pattern in TypeScript
https://github.com/foxifyjs/odin

activerecord database graphql model model-schema mongodb nodejs odin typescript

Last synced: 8 days ago
JSON representation

Odin is an implementation of the Active Record pattern in TypeScript

Host: GitHub
URL: https://github.com/foxifyjs/odin
Owner: foxifyjs
License: mit
Created: 2018-04-15T14:41:37.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-09-06T10:00:02.000Z (2 months ago)
Last Synced: 2024-10-29T20:22:34.393Z (17 days ago)
Topics: activerecord, database, graphql, model, model-schema, mongodb, nodejs, odin, typescript
Language: TypeScript
Homepage: https://odin.js.org
Size: 1.5 MB
Stars: 20
Watchers: 3
Forks: 1
Open Issues: 21
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Odin 

Odin is an implementation of [**Active Record**](https://en.wikipedia.org/wiki/Active_record_pattern) pattern in [**TypeScript**](https://typescriptlang.com).

[![NPM Version](https://img.shields.io/npm/v/@foxify/odin.svg)](https://www.npmjs.com/package/@foxify/odin)

[![Node Version](https://img.shields.io/node/v/@foxify/odin.svg)](https://nodejs.org)

[![TypeScript Version](https://img.shields.io/npm/types/@foxify/odin.svg)](https://www.typescriptlang.org)

[![Tested With Jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)

[![Pull Requests](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](https://github.com/foxifyjs/odin/pulls)

[![License](https://img.shields.io/github/license/foxifyjs/odin.svg)](https://github.com/foxifyjs/odin/blob/master/LICENSE)

[![Build Status](https://github.com/foxifyjs/odin/workflows/Test/badge.svg)](https://github.com/foxifyjs/odin/actions)

[![Coverage Status](https://codecov.io/gh/foxifyjs/odin/branch/master/graph/badge.svg)](https://codecov.io/gh/foxifyjs/odin)

[![Package Quality](http://npm.packagequality.com/shield/%40foxify%2Fodin.svg)](http://packagequality.com/#?package=@foxify/odin)

[![Dependencies Status](https://david-dm.org/foxifyjs/odin.svg)](https://david-dm.org/foxifyjs/odin)

[![NPM Total Downloads](https://img.shields.io/npm/dt/@foxify/odin.svg)](https://www.npmjs.com/package/@foxify/odin)

[![NPM Monthly Downloads](https://img.shields.io/npm/dm/@foxify/odin.svg)](https://www.npmjs.com/package/@foxify/odin)

[![Open Issues](https://img.shields.io/github/issues-raw/foxifyjs/odin.svg)](https://github.com/foxifyjs/odin/issues?q=is%3Aopen+is%3Aissue)

[![Closed Issues](https://img.shields.io/github/issues-closed-raw/foxifyjs/odin.svg)](https://github.com/foxifyjs/odin/issues?q=is%3Aissue+is%3Aclosed)

[![known vulnerabilities](https://snyk.io/test/github/foxifyjs/odin/badge.svg?targetFile=package.json)](https://snyk.io/test/github/foxifyjs/odin?targetFile=package.json)

[![Github Stars](https://img.shields.io/github/stars/foxifyjs/odin.svg?style=social)](https://github.com/foxifyjs/odin)

[![Github Forks](https://img.shields.io/github/forks/foxifyjs/odin.svg?style=social&label=Fork)](https://github.com/foxifyjs/odin)

## Table of Content 

- [Installation](#installation)

- [Usage](#usage)

- [Features](#features)

- [TODO (RoadMap to version 1.0.0)](#todo-roadmap-to-version-100)

- [Versioning](#versioning)

- [Changelog](#changelog)

- [Authors](#authors)

- [License](#license)

- [Support](#support)

## Installation

Before installing, [download and install Node.js](https://nodejs.org/en/download).

Node.js 8 or higher is required.

```bash

npm i -s @foxify/odin

```

## Usage

```javascript

const Odin = require("@foxify/odin");

const { Types } = Odin;

class User extends Odin {

}

User.schema = {

  email: Types.String.email.required,

  name: {

    first: Types.String.min(3).required,

    last: Types.String.min(3),

  }

};

```

## Features

1. Written in `ES6`

2. `TypeScript` ready

3. `Active Record` pattern

4. `Schema` validation

5. `GraphQL Schema` generator (based on model schema)

6. `JSON Schema` generator (based on model schema)

## TODO (RoadMap to version 1.0.0)

- [x] `Schema` validation

- [ ] Model

  - [ ] Hooks

    - [x] `create`

    - [ ] `update`

    - [ ] `delete`

    - [ ] `restore`

  - [ ] Relationships

    - [x] `embedMany`

    - [x] `hasMany`

    - [x] `hasOne`

    - [ ] `hasManyThrough`

    - [ ] `hasOneThrough`

    - [ ] `Polymorphic`

      - [x] `morphMany`

      - [x] `morphOne`

      - [ ] `morphTo`

      - [ ] `morphManyThrough`

      - [ ] `morphOneThrough`

      - [ ] `morphToThrough`

    - [x] CRUD operations

      - [x] Create operation

      - [x] Read operation

      - [x] Update operation

      - [x] Delete operation

  - [x] `GraphQL` support

  - [x] `JSON Schema` support

- [ ] Migrations

- [ ] Seeding

- [ ] Tests

## Versioning

We use [SemVer](http://semver.org) for versioning. For the versions available, see the [tags on this repository](https://github.com/foxifyjs/odin/tags).

## Changelog

See the [CHANGELOG.md](CHANGELOG.md) file for details

## Authors

- **Ardalan Amini** - *Core Maintainer* - [@ardalanamini](https://github.com/ardalanamini)

See also the list of [contributors](https://github.com/foxifyjs/odin/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Support

If my work helps you, please consider

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ardalanamini)

[![Become A Patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/ardalanamini)