Skip to content

Open source nosql database used for small projects written in javascript.

License

Notifications You must be signed in to change notification settings

Kubiczeek/db-quickly

Repository files navigation

Database-quickly

An easy to use noSQL database (json database) for javascript and typescript.

🎈 Getting Started

To start using this package, follow these easy steps bellow to get you started!

🛠️ Installation Steps

  1. Use your favourite package manager to install db-quickly 🚀
pnpm install db-quickly
  1. Thats it! Easy isn't it? Have fun! ❤️

📰 Documentation

Here is a list of availible Classes and its functions:

Database

  • addCluster
  • getClusterById (ByName)
  • getAllClusters
  • deleteClusterById (ByName)
  • updateClusterById (ByName)

Cluster

Note: data can be found under cluster.data

  • insertData

Schema

  • validateData

Others

  • newItem - creates new item for the Schema
  • SchemaTypes - list of allowed Types for a schema Items

🍰 Contributors

  • Kubiczeek - Everything (Frontend, Backend, and UI) - Kubiczeek

About

Open source nosql database used for small projects written in javascript.

Resources

License

Stars

Watchers

Forks