ByteDatabase: Built for Beginners

Table of Content

• Features
• Installation
• Changelog
• Quick Examples
• Contributors

Features

• Persistent Storage: Data stored won't disappear through restarts.
• Support for non-javascript/typescript projects: With our API (on development) you can use the database on any project you want.
• Built for Beginners: Our database is beginner friendly and our docs are straight-foward.

Installation

Using NPM:

npm i byte.db

Installing the dev build:

npm i https://github.com/cloudteamdev/ByteDatabase

If you're having issues with installing, please read our troubleshooting guide here

Changelog

nothing yet

Quick Examples

in ES6:

import { ByteDatabase } from 'byte.db';

in CommonJS:

const { ByteDatabase } = require('byte.db');

initialise the database by doing:

const bytedb = new ByteDatabase();
// use default path and properties (learn more: https://github.com/cloudteamdev/ByteDatabase/docs/guide.md#properties)

snippets:
┕ insert:

bytedb.insert('hello_world', 'helloworld'); // { changes: 1, lastInsertRowid: 1 }

┕ find:

bytedb.find('hello_world'); // helloworld

for more detailed examples check out our guide here

This database is an official project by the CloudTeam and is managed by avonryle#2022 in discord.

Contributors ✨

This database is an official project by the CloudTeam and is managed by avonryle#2022 at discord.

Thanks goes to these wonderful people who contributed to this project:

oriel-beck 💻 🐛