/typescript-sdk-starter

starter for write a SDK, like the facebook SDK. which will be one js file and bootstrap itself after call init() method.

Primary LanguageTypeScript

typescript SDK starter

NOTES

  • starter for write a SDK, like the facebook SDK.
  • result will be one .js file and which bootstrap itself after call init() method.

Development

  1. To build you need to run npm run build
  2. SDK will be placed in dist
  3. To start project run npm run start

How to bundle SDK and test it with website

  • npm run build
  • take something.sdk.js file from /dist folder
  • add this two line in html of your site
  <div id="sdk-something"></div>
  <script src="./something.sdk.js"></script>
  • SDK will be initialized in <div id="sdk-something"></div> after call javascript function SomethingSDK.init() from anywhere

Project structure

  • write your library name in webpack.config.js file, for every global functions. E.g. SomethingSDK.init()

    module.exports = {
  .......
  output: {
    .......
    library: 'SomethingSDK'
  },
  ........
}

  • export everything from SomethingSDK.ts, what you want to access globally

  • write styles (.css, .scss,sass) in style folder

  • every visually element extends component class

  • RouterService singleton class used for navigation between pages

  • Core class connects services, components and router each other

See Example