unixdb v0.0.2

UnixDB

Este é o projeto de um banco de dados baseado em JSON que visa estabilidade, segurança e velocidade.

WARNING: Este projeto ainda está em desenvolvimento e sua primeira versão pública será publicada em breve.

Sumário

1. Instalação
2. Começando
3. Contribuindo
4. Licença

Instalação

1. Baixe utilizando NPM (Node Package Manager).

$ npm install unix.js

2. Baixe utilizando Yarn.

$ yarn add unix.js

3. Baixe utilizando PNPM.

$ pnpm add unix.js

Começando

Este é um banco de dados baseado em um esquema JSON com pares chave: valor.

Vamos começar importando a classe Unix e criando uma nova instância da mesma:

import { Unix } from "unix-db";

const db = new Unix();

// faça algo...

Depois de criar sua instância pode começar a executar ações dentro do banco de dados normalmente. Consulte na documentação a página de referência da api.

Segue um breve exemplo prático:

import { Unix } from "unix-db";

const db = new Unix();
const uuid = generateUUID();

db.set(`users.${uuid}`, {
  name: "Eric",
  sobrenome: "Freitas",
  idade: 17,
  stack: ["rust", "kotlin", "c#", "typescript", "go"],
});

db.save();

Para mais informações e exemplos verifique a documentação.

Contribuindo

Para você desenvolvedor Typescript/Javascript com desejo de impulsionar o mundo de desenvolvimento open-source informamos que este repositório aceita pull request e issues.

Para contribuir siga estes passos:

1. Clone esse repositório em sua máquina: git clone https://github.com/freitaseric/unix-database ou baixe o arquivo .zip.
2. Crie sua branch: git checkout -b <sua_feature>.
3. Faça suas modificações e/ou implementações.
4. Por fim, envie seu pull request.

Após estes passos basta aguardar que irei analisar e, se cabível, fazer o merge na branch main.

Licença

Este repositório está sob a licença MIT, verifique o arquivo LICENSE antes de redistribuir este projeto.