Skip to content

Latest commit

 

History

History
62 lines (35 loc) · 1.89 KB

README.md

File metadata and controls

62 lines (35 loc) · 1.89 KB
Raw

QuipoDB

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 and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • 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 and the NPM.

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