baasic-sdk-javascript

JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
17May 9, 2021Mar 31, 2015Minified + gzip package size for baasic-sdk-javascript in KB

Readme

Baasic JavaScript SDK

Baasic JavaScript library provides integration access to Baasic REST API core end-points.

Dependencies

Baasic JavaScript library has the following dependencies:

Usage

This section will describe how to add the Baasic JavaScript library to your project. It's important to know that Baasic JavaScript SDK uses JSON format by default and it be setup to use HAL+JSON format for the back-end communication. You can find out more about HAL format here.

Adding the library to your project

Please add the following lines of code after the jQuery include (if you are installing this as a dependency of Baasic Angular SDK, or any other framework, you can safely ignore jQuery dependency):

<script src='https://code.jquery.com/jquery-3.1.1.slim.min.js'></script>
<script src='/js/hal-parser.js'></script>
<script src='/js/uritemplate-min.js'></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/reflect-metadata/0.1.10/Reflect.min.js"></script>
<script src='/js/baasic-sdk-javascript-2.0.0.min.js'></script>

Note: Baasic JavaScript SDK depends on reflect-metadata package, in order to use the sdk directly and not as a part of another JavaScript framework reflect-metadata should be manually imported into the project. Other Baasic SDKs or frameworks may handle this dependency automatically. jQuery dependency should be used only if sdk is used separately from other JavaScript frameworks, if sdk is used as a part of some framework (e.g. Angular) then sdk for that specific framework should be used and jQuery is not needed as a dependency.

Application Configuration

To create the BaasicApp you will need to use the baasicSdkJavaScript object on the global scope.

//Note: this is configuration example only, these are the defaults
var options = {
    apiRootUrl: 'api.baasic.com',
    apiVersion: '<version>',
    enableHALJSON: false
};

var application = new baasicSdkJavaScript.BaasicApp('<api-key>', options);

Module Usage

application.membershipModule.login.login({
    username: '<username>',
    password: '<password>'
}).then(function (data) {
    //Do your work here
}, function (data) {
    console.log(data);
});

Baasic Modules

Baasic back-end contains various built-in modules that can be easily consumed through the Baasic JavaScript library. Baasic Developer Center contains detailed information about all the core modules supported by the JavaScript library.

Build Process

  1. Install NodeJs
  2. Open Shell/Command Prompt in the Baasic JavaScript folder
  3. Run npm install
  4. npm run build:dev or npm run build:prod

Baasic JavaScript library has the following developer dependencies:

Contributing

Pull requests are always welcome

We appreciate pull requests you make, and we'll do our best to process them as quickly as we can. Even if it's just a typo you found or any small or large issue you fixed - please do it! It will help us a lot.

If your pull request is not accepted on your first try, don't be discouraged! If there's a problem with your implementation, hopefully you received feedback on what to improve.

Issue reporting

Before you create a new issue, please make sure it hasn't already been reported. In case it already exists simply add a quick "+1" or "I have the same problem" to the existing issue thread.

Other
  • Help us write the documentation
  • Create interesting apps using SDK
  • Looking for something else to do? Get in touch ...

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.