@drieam/common

---

menu: '@drieam/common' name: 'Getting Started' route: /common

@drieam/common

This package include some utilities used by Drieam LTI apps.

Getting Started

Installation

Install the @drieam/common and its dependencies.

yarn add @drieam/common @drieam/api @drieam/models @drieam/ui

Usage

import { connectActions, connectReducers } from '@drieam/api';
import * as models from '@drieam/models';
import { setStore } from '@drieam/common';

type API = {
  user: models.canvas.user;
};

type Store = RootReducer<{
  api: ConnectReducers<API>;
}>;

const api: ApiRoutes<API> = {
  user: {
    onError,
    path: '/lti/proxy/api/v1/users/:id?',
    mapper: models.canvas.User,
    list: true,
  },
};

const actions = connectActions<API>(api);
const rootReducer = connectReducers<API>(api);
const store = setStore(
  api,
  rootReducer,
  [/** EMPTY MIDDLEWARES **/],
  defaultOptions,
)({
  /* EMPTY INITIAL STATE */
});

Read the full API Documentation

Components

ApiTable

ApiWrapper

Contributing

We welcome all contributors who abide by our Code of Conduct. Please see the Contributors Guide for more details on submitting a PR, setting up a local dev environment, running tests, etc...

Versioning

Until this project reaches a 1.0 milestone, minor version numbers will simply be incremented during each release. The Changelog will continue to document the different types of updates, including any "breaking changes".

After the 1.0 milestone, this project will follow SemVer.

License

To Be Fill..