Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/notaphplover/ant-js

Generic query manager that scales!
https://github.com/notaphplover/ant-js

nodejs redis typescript

Last synced: about 1 month ago
JSON representation

Generic query manager that scales!

Host: GitHub
URL: https://github.com/notaphplover/ant-js
Owner: notaphplover
License: mit
Created: 2019-02-28T19:05:34.000Z (almost 6 years ago)
Default Branch: develop
Last Pushed: 2023-01-05T03:55:40.000Z (about 2 years ago)
Last Synced: 2024-11-28T20:47:59.709Z (about 2 months ago)
Topics: nodejs, redis, typescript
Language: TypeScript
Size: 1.92 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG_V1.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

[![Build status](https://github.com/notaphplover/ant-js/workflows/ci/badge.svg)](https://github.com/notaphplover/ant-js/workflows/ci/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/notaphplover/ant-js/badge.svg?branch=develop)](https://coveralls.io/github/notaphplover/ant-js?branch=develop)
[![npm version](https://badge.fury.io/js/%40antjs%2Fant-js.svg)](https://badge.fury.io/js/%40antjs%2Fant-js.svg)

## Description

Scalable query manager for redis. This library receives a set of models and queries and manages the access to redis and database servers.

## Status

We finally released an stable version! The library is still being tested in a preproduction environments of a backend service.

## How to install the library

You can donwnload the library direclty, clone it or install it as a npm dependency:

```
npm i @antjs/ant-js
```

## How to build the library

Just run the build script:

```
npm run build
```

## How to run tests

Tests are dockerized in order to start a redis server in a virtual environment.

You can run all the tests with the test script:

```
npm test
```

A coverage report will be generated at the coverage directory.

## Aknowledgements

Special thanks to [Pablo López Torres](https://github.com/supertowers) for the theoretical knowledge and conversations that led to this project.

## Tutorials and Documentation

See more [tutorials](https://notaphplover.github.io/ant-js/tutorial/introduction.html) and [documentation](https://notaphplover.github.io/ant-js/).