Unix.db

A non-relacional database for your node.js projects.

Table Of Contents

1. Installation
2. Basic Usage
3. Documentation

Installation

For use this package you need to install they via any package manager for node.

1. NPM

  $ npm install unix.db --save

2. Yarn

  $ yarn add unix.db

3. PNPM

  $ pnpm add unix.db

Basic Usage

Bellow is a basic example of how to use the Unix.db

• Typescript version

import { UnixDB, type BaseSchema } from "unix.db";

interface UserSchema {
  username: string;
  email: string;
  password: string;
  age: number;
  hasPremium?: boolean;
}

const db = new UnixDB<UserSchema>({
  driver: "memory",
});

const user = db.$create({
  // This object is of type UserSchema
});

console.log(user);

• Javascript version

const { UnixDB } = require("unix.db");

const db = new UnixDB({
  driver: "memory",
});

const user = db.$create({
  // Javascript is not statically tiped
});

console.log(user);

Documentation

Full documentation can be accessed here!

• Link: https://unixlab-tech.github.io/unix.db/ (Coming soon...)

Authors

• @freitaseric

Contributions

Your suggestion is welcome for this repository, if you have identified an error in our library, or have any feature ideas for it, feel free to help us. Any help is welcome!

Step by step:

1. Make a clone of this repository: git clone https://github.com/unixlab-tech/unix.db (You may want to add --branch develop to get the latest version of the lib.)
2. Create your branch: git checkout -b feature/my-feature or git checkout -b bugfix/my-bugfix
3. Make any changes that fit the context of your contribution.
4. Make a pull request to this repository: https://github.com/unixlab-tech/unix.db/pulls