@yellowlabs/sdk

    0.7.1 • Public • Published

    js-semistandard-style

    Yellow Labs SDK

    Yellow labs is a learning materials creation (collaboration) and distribution platform. This is the Javascript SDK for developing yellow labs app.

    Installation and Usage

    cd <project-directory>
    $ yarn add fireabse @yl/sdk
    import ylSdk from '@yl/sdk';
     
    // initialize the sdk
    const rethinkConfig = {
      // ...other configs
    };
     
    ylSdk.initilize({ rethinkConfig });
     
    // observe the current user
    ylSdk.auth().currentUser$(console.log);
     
    // signin
    ylSdk.auth().signin('local', { email: 'my@email.com', password: 'some-passwrd' })

    Services

    • accounts - mmSdk.accounts()
    • auth - mmSdk.auth()
    • badges - mmSdk.badges()
    • core - mmSdk.core()
    • curricula - mmSdk.curricula()
    • materials - mmSdk.materials()
    • organizations - mmSdk.organizations()

    see docs for more info

    Related npm modules

    • @yl/sdk-vue - vue-plugin implemented sdk that integrates well with vuex (store/state-persistence) and vue-router (guards)
    cd <project-directory>>
    $ yarn add vue vuex vue-router firebase @yl/{sdk,sdk-vue}
    import Vue from 'vue';
    import Vuex from 'vuex';
    import VueRouter from 'vue-router';
    import YlSdk from '@yl/sdk-vue';
     
    const store = new Vuex();
    const router = new VueRouter();
     
    Vue.use(YlSdk, { store, router })

    Keywords

    Install

    npm i @yellowlabs/sdk

    DownloadsWeekly Downloads

    7

    Version

    0.7.1

    License

    MIT

    Last publish

    Collaborators

    • yellowlabs