https://github.com/r-rajaneesh/quipodb

A database that does all the heavy weightlifting behind the scenes
https://github.com/r-rajaneesh/quipodb

better-sqlite3 database firebase hacktoberfest json nodejs sqlite

Last synced: 3 months ago
JSON representation

A database that does all the heavy weightlifting behind the scenes

• Host: GitHub
• URL: https://github.com/r-rajaneesh/quipodb
• Owner: r-rajaneesh
• Created: 2022-06-27T17:59:37.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-24T15:43:15.000Z (over 3 years ago)
• Last Synced: 2025-06-10T04:05:44.931Z (about 1 year ago)
• Topics: better-sqlite3, database, firebase, hacktoberfest, json, nodejs, sqlite
• Language: TypeScript
• Homepage: https://r-rajaneesh.github.io/quipodb
• Size: 599 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md

Awesome Lists containing this project

README

          
# QuipoDB

![](./QDB.png)

> A key-value json type database stored in a compressed form, reducing database size to the minimum

---

## Requirements

For development, you will only need Node.js installed in your environment.

### Node

- #### Node installation on Windows

  Just go on [![official Node.js website](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white) and download the installer.

  Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).

- #### Node installation on Ubuntu

  You can install nodejs and npm easily with apt install, just run the following commands.

      $ sudo apt install nodejs

      $ sudo apt install npm

- #### Other Operating Systems

  You can find more information about the installation on the [![official Node.js website](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white) and the [![NPM](https://img.shields.io/badge/NPM-%23000000.svg?style=for-the-badge&logo=npm&logoColor=white)](https://npmjs.org/).

If the installation was successful, you should be able to run the following command.

    $ node --version

    v18.8.0

    $ npm --version

    8.18.0

If you need to update `npm`, you can make it using `npm`! Cool right? After running the following command, just open again the command line and be happy.

    $ npm install npm -g

### TODO

- Make a new Icon

- Make README more nice

- Add upcoming features in PR's

### Npm installation

After installing node, initilize your npm project by

      $ npm init -y

And install the package using

      $ npm install quipodb

---

### Usage

Read the [docs](https://r-rajaneesh.github.io/quipodb)

For more support join my [discord server](https://discord.com/invite/Gmxxw6KfEF)