⚠️ This repository is archived.

Tigris has pivoted from this database project to a new, globally distributed S3-compatible object storage service. Learn more about the new product here: https://www.tigrisdata.com/

Tigris TypeScript Client Library

Documentation

• Tigris Overview
• Getting Started
• Database
• Database + Search
• Search Only
• Vector Search

Building

# clean the dev env
npm run clean

# build
npm run build

# test
npm run test

# lint
npm run lint

Installation note for Apple M1

Since ARM binaries are not provided for grpc-tools package by the grpc team. Hence, the x86_64 version of grpc-tools must be installed.

npm_config_target_arch=x64 npm i grpc-tools
npm i

Code Quality

1. Linting

The coding style rules are defined by Prettier and enforced by Eslint

2. Git Hooks

We use pre-commit to automatically setup and run git hooks.

Install the pre-commit hooks as follows:

pre-commit install

On every git commit we check the code quality using prettier and eslint.

License

This software is licensed under the Apache 2.0.

Contributors

Thanks to all the people who contributed!