featherdb
v1.0.2
Published
An advanced light-weight database FeatherDB
Readme
FeatherDB
FeatherDB is a lightweight, privacy-first, fully local encrypted database for Node.js.
Your data never leaves your machine. No cloud. No servers. No accounts.
Why FeatherDB?
Most databases require you to trust third-party services or run heavy servers.
FeatherDB is built for developers who want full control over their data.
- No MongoDB
- No external services
- No telemetry
- No tracking
- No network usage
Features
- Fully local file-based database
- Encrypted storage using a secret key
- Automatic compression (gzip)
- One file per model (
.fdb) - Simple schema support
- Zero required dependencies
- Event system (
ready,error) - Fast and lightweight
Installation
npm install featherdbGetting Started
const FeatherDB = require("featherdb");
FeatherDB.connect("./data", "my-secret-key")
const Users = FeatherDB.model("users", {
username: String,
email: String
})This will create an encrypted file:
data/users.fdbEncryption & Storage
FeatherDB never stores raw JSON.
Data flow:
- JSON serialization
- gzip compression
- XOR encryption using SHA-256 derived key
- Base64 encoding
Large datasets are stored in very small, unreadable files.
Models
Each model creates its own encrypted .fdb file.
const Posts = FeatherDB.model("posts", {
title: String,
content: String
})Events
FeatherDB.on("ready", info => {
console.log("Database ready:", info.folder)
})
FeatherDB.on("error", err => {
console.error("DB error:", err)
})Use Cases
- Discord bots
- CLI tools
- Local dashboards
- Offline apps
- Privacy-focused software
Philosophy
Your data should belong to you.
FeatherDB is for developers who value privacy, ownership, and simplicity.
License
MIT
