@harishreddym/baqend

Baqend JavaScript SDK
=====================
Baqend JavaScript SDK and CLI for High-Performance Websites

* Docs and API
* CLI help
* Dashboard

CLI
-----
Baqend provides a CLI to easily manage your app. Install it by typing npm install -g baqend.
Afterwards you can use the baqend command in your terminal.

If you don't already have a Baqend account, type baqend register to create your first app.
Now you can open the dashboard of your app with baqend dashboard. To see all the command use baqend help.

Setup
-----

To use the Baqend SDK, just include the baqend.js or
baqend.min.js from the dist folder
at the bottom of your body.

Alternatively you can install the Baqend SDK with npm. Just type npm install --save-dev baqend

Or install with bower bower install --save-dev baqend

Or download the latest release directly from GitHub.

``html




`

You can also include it from our CDN-Provider fastly.
`html




`

The Baqend SDK provides a global DB variable by default.


Baqend Real-Time SDK
--------------------
If you want to use real-time queries, you have to either use baqend-realtime.js or
baqend-realtime.min.js for production.
In Addition, you can include Rx.js v5 into your project, for many advanced
Observable features.
You can use the unpkg CDN:
`html



`
The SDK is shipped with the core-js Observable shim per default.
If you include Rx.js globally, it will be detected and used by the SDK automatically.
You can also set the Observable implementation which the SDK will use,
by setting the require('baqend/realtime').Observable = Observable afterwards.

Initialize
----------

Before you can actually use the Baqend SDK, you must link the Baqend SDK to your Baqend Account.
Just call DB.connect() after including the Baqend SDK.

The Baqend SDK connects to your Baqend and initialize the SDK. If the connection was successfully established
the ready callback will be called and the DB can be used to load, query and save objects.

`html


`


Usage in Node.js
----------------

The Baqend SDK can also be used in Node.js. Just do an npm install --save baqend and use require('baqend') in your code.

`javascript
var DB = require('baqend');

// connects to your Baqend Accounts example app
DB.connect('example');

// waits while the SDK connects to your Baqend
DB.ready(function() {
// work with your Baqend
DB.User.find()
...
});
`

Note: The Baqend Real-Time SDK can be required with var DB = require('baqend/realtime');, ensure that you only
require either the Baqend SDK or the Baqend Real-Time SDK and not both.

Building with browserify
--------------------------------------------------

Just install baqend with npm install --save-dev baqend, require('baqend') in your code
and build the Baqend SDK + your code with browserify.

`javascript
var DB = require('baqend');

// connects to your Baqend Accounts example app
DB.connect('example');

// waits while the SDK connects to your Baqend
DB.ready(function() {
// work with your Baqend
DB.User.find()
...
});
`

Note: The Baqend Streaming SDK can be required with var DB = require('baqend/realtime');, ensure that you only
require either the Baqend SDK or the Baqend Streaming SDK and not both.

Type browserify scripts/main.js > scripts/bundle.js to build your main.js script.
For more advanced building steps visit the browserify Documentation.

Building with requirejs
------------------------------------------------

Use the Baqend SDK from the /dist folder or install the SDK via npm npm install --save-dev baqend.
Add the Baqend SDK as a dependency of your script and use the required Baqend SDK.

`javascript
require(["scripts/baqend.js"], function(DB) {
// connects to your Baqend Account
DB.connect('example');

// waits while the SDK connects to your Baqend
DB.ready(function() {
// work with your Baqend
DB.User.find()
...
});
});
``

For more advanced usage of requirejs visit the requirejs Documentation.

License
-------

This Baqend SDK is published under the very permissive MIT license