Skip to content

modscleo4/jsdb

Repository files navigation

JSDB - JSON Database Manager

Build Status

What is JSDB?

JSDB is a project to create a Node.js database manager which supports SQL. Built on JavaScript, the JSDB uses JSON to store database data.

The JSDB Server and Client source code is licensed under Apache 2 License

Installation

To install JSDB from GitHub (latest build), clone this repo and install with NPM:

$ git clone https://github.com/modscleo4/jsdb.git
$ npm install -g jsdb

Or

$ npm install -g modscleo4/jsdb

For stable releases, install from NPM

$ npm install -g @modscleo4/jsdb

Run

After installed, you can run JSDB just typing

$ jsdb [-h] [-d dir] [-a address] [-p port] [-N] [-Z] [-L] [-R]

Where the possible arguments are:

Command Description
-h, --help Displays this table
-d, --dir Where JSDB should store the data
-a, --listenIP Which IP to listen on
-p, --port What port to listen
-N, --noAuth Disable authentication
-Z, --createZip Enable backup system
-L, --generateLogs Enable Log system
-R, --regAutoReload Enable Registry auto reload
--sql Runs a SQL statement as admin

Issues and suggestions

Use the Issues page to send bug reports and suggestions for new features

Contributing

Feel free to fork and send Pull Requests to JSDB Server and Client projects, I'll love to see new contributions for these projects!

Client

The official JSDB client is available at https://github.com/modscleo4/jsdbclient

Releases

No releases published

Packages

No packages published