JavaScript library for the SaasPro

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then, install it via:

      npm install saas_pro --save      

Finally, you need to build the module:

     npm run build      

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

     npm install      

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

      npm link      

To use the link you just defined in your project, switch to the directory you want to use your saas_pro from and run:

      npm link /path/to/<JAVASCRIPT_CLIENT_DIR>      

Finally, you need to build the module:

      npm run build      

git

If the library is hosted at a git repository, for example https://github.com/GIT_USER_ID/GIT_REPO_ID, install it via:

       npm install GIT_USER_ID/GIT_REPO_ID --save      

For browser

The library also works in the browser environment via npm and Browserify. After following the above steps with Node.js and installing Browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

     browserify main.js > bundle.js       

Then include bundle.js in the HTML pages.

Webpack configuration

Using Webpack, you may encounter the following error: "Module not found: Error: Cannot resolve module". Most certainly, you should disable AMD loader. Add and merge the following section to your Webpack config:

      module: {
        rules: [
          {
            parser: {
              amd: false
            }
          }
        ]
      }

Please follow the installation instructions and execute the following JavaScript code: