https://github.com/codetheearth/flaredb
syntax of mongoose, freedom of sqlite
https://github.com/codetheearth/flaredb
database mongoose sqlite
Last synced: 4 months ago
JSON representation
syntax of mongoose, freedom of sqlite
- Host: GitHub
- URL: https://github.com/codetheearth/flaredb
- Owner: CodeTheEarth
- License: mit
- Created: 2025-09-19T19:14:19.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-09-26T16:24:38.000Z (4 months ago)
- Last Synced: 2025-09-27T10:43:37.664Z (4 months ago)
- Topics: database, mongoose, sqlite
- Language: TypeScript
- Homepage:
- Size: 56.6 KB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FlareDB 🔥
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Why Project FlareDB](#why-project-flaredb)
- [How to use?](#how-to-use)
- [FlareCache](#flarecache)
- [How to use FlareCache?](#how-to-use-flarecache)
- [Contributors](#contributors)
## Introduction:
FlareDb is an ongoing project that focuses on simplicity and efficiency. It is intended to be a self hosted database where individuals will be able to host and use with ease. The purpose of `FlareDb` is not to compete with the likes of `sqlite`, `mongodb` and so on but rather to aid our organisation [CodeTheEarth](https://github.com/CodeTheEarth)
## Features:
- JSON document based database (inspo from `mongodb`)
- Single `.db` file database(inspo from `sqlite`)
- Indexing
- Ease of use
- Zero external dependencies
- Low ram usage (10k documents -> 38mb ram aproximately)
## Why Project FlareDB
Project flareDB as stated above is to aid our organisation [CodeTheEarth](https://github.com/CodeTheEarth) with a personal self hosted database to run our operations. That said, this is a completely open source project meaninig other developers can contribute, sponsor, take inspo from and self use for themselves >_<. This project should effectively solve the issues facing our organisation and other developers which relates to complexity of other databases and for some.. pricing.
### How to use
First make sure you have node installed
- Installing dependency:
```
npm install https://github.com/codetheearth/flaredb
```
- Initializing a database
```
const db = new Flare("users.db");
```
- Creating a new document
```
const Users = db.collection("users", { name: "string", age: "number" }); //example schema
```
- Inserting into documents
```
await Users.put({ name: "Haki", age: 18 });
```
- Return whole document
```
const all = await Users.find();
console.log("All users:", all)
```
- Find one
```
const haki = await Users.findOne({ name: "Kaima" });
console.log("Find one:", haki.age);
```
- Update
```
await Users.updateOne({ name: "Haki" }, { age: 19 }); // update first match
await Users.updateMany({ age: 20 }, { age: 21 }); // bulk update
```
- Delete
```
await Users.deleteOne({ name: "Kaima" }); // delete first match
await Users.deleteMany({ age: 21 }); // delete all matches
await Users.clear(); // wipe entire collection
```
## FlareCache
This is a simple `redis` like key value pair db for things like cache and so on
### How to use FlareCache?
```
const cache = new FlareCache()
await cache.set("name", "haki")
console.log(cache.get("name"))
```
### Contributors
- [Haki](https://github.com/hakisolos)
- [Kay](https://github.com/Kay-design3)
- [King david](https://github.com/KING-DAVIDX)
- [Xcelsama](https://github.com/Xcelsama)
- [Kelly](https://github.com/)
### Other contributors
- [Astro](https://github.com/astrox11)
> CODE THE EARTH !!