Quick.db
Documentation: quickdb.js.org
Support: discord.gg/plexidev
NPM: npmjs.com/quick.db
Quick.db is an open-source package meant to provide an easy way for beginners and people of all levels to access & store data in a low to medium volume environment. All data is stored persistently via better-sqlite3 and comes way various other quality-of-life features.
- Persistent Storage - Data doesn't disappear through restarts
- Works out of the box - No need to set up a database server, all the data is stored locally in the same project
- Beginner Friendly - Originally created for use in tutorials, the documentation is straightforward and jargon-free
- & more...
Example
const db = ; // Setting an object in the database:db// -> { difficulty: 'Easy' } // Pushing an element to an array (that doesn't exist yet) in an object:db// -> { difficulty: 'Easy', items: ['Sword'] } // Adding to a number (that doesn't exist yet) in an object:db// -> { difficulty: 'Easy', items: ['Sword'], balance: 500 } // Repeating previous examples:db// -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 500 }db// -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 1000 } // Fetching individual propertiesdb // -> 1000db // ['Sword', 'Watch']
Installation
If you're having troubles installing, please follow this troubleshooting guide.
Linux & Windows
npm i quick.db
Note: Windows users may need to do additional steps listed here.
Mac
- Install: XCode
- Run:
npm i -g node-gyp
in terminal - Run:
node-gyp --python /path/to/python2.7
(skip this step if you didn't install python 3.x) - Run:
npm i quick.db
Support
I work on this project in my spare time, if you'd like to support me, you can do so by buying me a coffee! ❤️