localbased

A JSON based DBMS for local use (a firebase inspired project🙂), Thanks to localbased you get to focus more on the your frontend Implementations

Installation

npm i -g localbased

Initialization

In your current working directory run localbased start --port [port] this command starts the server on the specified port else the server runs on a default port of 2048.

E.g

localbased start --port 4000 this command starts the server on the specified port 4000

localbased start this command starts the server on the default port 2048

Endpoints

/:collectionName/create method: POST; payload: check below; This creates a document in the specified collection

  request.body: {
       ...data
    }

• E.g /comments/create this creates a document(comment) in the comments collection

• Note collectionName is just like a table's name in SQL and is created once the first document is created

/:collectionName/get/all?order=a method: GET; payload: no payload; This returns all the document in the specified collectionName

• Note order=a this returns the documents in an assending order otherwise use order=d for descending order

/:collectionName/get/single/:id method: GET; payload: no payload; This returns the document with the specified id

/:collectionName/update/:id method: PATCH; payload: check below; This updates a document with the specified id

   request.body: {
     update: {
         ...updates
     }
   }

/:collectionName/delete/:id method: DELETE; payload: no payload; This deletes a document with the specified id

...Start Building 🚀🚀

Thank you for using localbased