andoncloud-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.4.68 • Public • Published

Andoncloud SDK

SDK to use with all Andoncloud microservices.

Installing

Run npm install --save andoncloud-sdk

Deployment

Change the version number in package.json in order to publish code to npm.

Usage

Router:

Use <AndonCloudRouter/> instead of your react-router. import AndonCloudRouter from 'andoncloud-sdk';

<AndonCloudRouter shouldAuthenticate history={browserHistory} baseUrl={Config.API_URL}>
  ...
</AndonCloudRouter>

Container

You can pass all the props that you want, but you HAVE TO pass baseUrl prop with base url to your api. Wrap your outer container with <Container/> in order to use the provided header and navigation drawer. Remember to pass baseUrl to Container.

import Container from 'andoncloud-sdk';

<Container baseUrl={Config.API_URL} >
  ...
</Container>

Pass showAcLogo and showCompanyLogo to Container in order to disable logotypes in the header.

import Container from 'andoncloud-sdk';

<Container baseUrl={Config.API_URL} showAcLogo={false} showCompanyLogo={false} >
  ...
</Container>

Push notification

To use push notification you have to include initializeAndonCloudNotification and you have to mount it in your main controller.

import {AndonCloudRouter, initializeAndonCloudNotification} from 'andoncloud-sdk';

Add to main component

componentWillMount() {
  initializeAndonCloudNotification(); // to do readme
}

render() {
  return (
    <MuiThemeProvider muiTheme={muiTheme}>
      <AndonCloudRouter history={browserHistory} baseUrl={'https://api.andoncloud.net'} shouldAuthenticate>
        <Route path="/" component={App} />
      </AndonCloudRouter>
    </MuiThemeProvider>
  )
}

To receive push notification even when card is closed you need to create Service Worker To do it you need to copy ServiceWorker firebase-messaging-sw.js to main folder.

  1. Install CopyWebpackPlugin using npm install --save-dev copy-webpack-plugin

  2. Add to your webpack-dist.conf.js:

    const CopyWebpackPlugin = require('copy-webpack-plugin'); const path = require('path');

    new CopyWebpackPlugin([ { from: 'service_workers/firebase-messaging-sw.js' } ])

Minimum resolution: 1024x600


This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Readme

Keywords

none

Package Sidebar

Install

npm i andoncloud-sdk

Weekly Downloads

282

Version

1.4.68

License

MIT

Unpacked Size

1.8 MB

Total Files

58

Last publish

Collaborators

  • andoncloud