Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rotorlab/flamebase-database-node
Realtime JSON database for Node.js (server)
https://github.com/rotorlab/flamebase-database-node
Last synced: about 1 month ago
JSON representation
Realtime JSON database for Node.js (server)
- Host: GitHub
- URL: https://github.com/rotorlab/flamebase-database-node
- Owner: rotorlab
- License: apache-2.0
- Created: 2017-05-28T00:05:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-28T13:18:21.000Z (about 7 years ago)
- Last Synced: 2024-11-07T23:28:58.066Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[ ](https://www.npmjs.com/package/flamebase-database-node)
# :fire: flamebase-database-node
Real time JSON database (server node).
### What is this?
Flamebase is an open source project that tries to emulate Firebase Database features as much as possible. I like Firebase but it's expensive for what it currently offers.
If you are doing an altruist project with Firebase, pray not to became successful, because the monthly amount will increase considerably.
In this repo you can find the proper package for work with json db as flamebase-database-server-cluster does.
For now it still developing, so please be patient with errors.
### Usage
- Import library:
```javascript
var FlamebaseDatabase = require("flamebase-database-node");
```
- Define database and reference to instance as JSON object:
```javascript
var database = "chats"; // database's name
var path = "groupA"; // path to JSON reference
var FD = new FlamebaseDatabase(database, "/" + path);
FD.syncFromDatabase(); // first load
```
Now `FD.ref` is `groupA` JSON object.
- Do some work and sync:
This JSON reference (`groupA`) contains this information:
```json
{
"people": {
"[email protected]": {
"name": "John Travolta",
"token": "AsDadfsdfsDFCGsdfgEgWEcgcEgcwEgWegwEgeGWHTrydhdfsDFCGsdfgEgWEcgcEgcwEgWegwEgrty",
"os": "android"
},
"[email protected]": {
"name": "Donal Duck",
"token": "DSfgsfgSgrtuyjYuIKyUyjRtyFytrydhdfsDFCGsdfgEgWEcgcEfgSgrtuyjYuIgcwEgWegwEgrty",
"os": "android"
}
},
"messages": {
"1495171941114": {
"author": "[email protected]",
"text": "Message 1"
},
"1495171941127": {
"author": "[email protected]",
"text": "Message 2"
},
"1495171941159": {
"author": "[email protected]",
"text": "Message 3"
},
"1495171941327": {
"author": "[email protected]",
"text": "Message 4"
}
}
}
```
For insert new messages on this conversation compose a new message JSON object:
```javascript
var message = {};
message.author = "[email protected]";
message.text = "Message 5";
var messageId = new Date().getTime() + "";
FD.ref.messages[messageId] = message;
FD.syncToDatabase();
```
At this point we have a JSON reference synchronized with our JSON database.
Define some configuration properties to keep devices up to date when JSON reference changes.
```javascript
var config = {};
/**
* server API key for firebase cloud messaging
*/
config.APIKey = function() {
return "GsdfgSVDfvsdAwejhFDGhbdASD"; // server key - FCM
};
/**
* all device objects must have token and os info in order
* to slice big JSON changes for android or ios push notifications
*/
config.devices = function() {
var devices = [];
var keys = Object.keys(FD.ref.people);
for (var i = 0; i < people.length; i++) {
var person = FD.ref.people[keys[i]];
var device = {};
device.token = person.token;
device.os = person.os;
devices.push(device);
}
return devices;
};
/**
* tag that informs android/ios client which action is being called
*/
config.tag = function() {
return path + "_sync"; // groupA_sync
};
/**
* custom id for client database (used as primary key)
*/
config.referenceId = function() {
return path; // groupA
};
/**
* custom notification to send when database reference changes.
* return null if not needed
*/
config.notification = function() {
return {
type: path + "_type", // notification type
name: "Database changed", // name or text message
image: "http://..." // image url to show on left notification icon
}
};
FD.setSyncConfig(config);
```
Now all reference changes are sent every time you call `FD.syncToDatabase()`. It only sends changes.
For sending full reference:
```javascript
FD.syncToDatabase(true);
```
Control synchronization process:
```javascript
FD.syncToDatabase(false, function() {
// data is stored and all push messages has been sent
console.log("data stored and differences sent!")
});
```
- Enable debug logs:
```javascript
FD.debug(true);
```