AppFit Javascript SDKs

A monorepo for the AppFit Javascript SDKs.

Included packages:

• Browser - NPM-hosted library for use with web apps
• CDN - a cdn-hosted bundle of the SDK. It wraps the browser library.
• Server - a server-based version of the SDK
• Shared - NPM-hosted library shared by other packages

Setup

1. Install NVM and run nvm use to switch to the proper Node version
2. Install dependencies:

   npm i

   NOTE: This is a mono repo (it uses workspaces), so there is only one node_modules for all projects.

Using Workspaces

This monorepo uses NPM's workspaces functionality (see documentation).

You may reference an individual workspace with npm by appending the option -w [workspace name] to a command, where [workspace name] is the name property in the workspace's package.json file.

For example, to install a package (e.g. luxon) to the server workspace, use:

npm i luxon -w @uptechworks/appfit-server-sdk

Building

1. Build all the packages:

   npm run build

Deployment

1. Version & tag the packages (this will push the tags!):

   npm run deploy:version

   Use the prompts to bump each package. It will ask for every package where it detects a change.
2. Push to prod branch to publish to NPM and update the CDN.
3. Update snippet in docs, if it was changed. (See section below)

Testing

1. Test the packages:

   npm run test

Updating browser script snippet

In the documentation, we give users a <script> tag to insert in a webpage. This code loads AppFit from a CDN.

This tag is generated by the build and just needs to be pasted into the documentation.

1. Run the build
2. In the cdn/dist/snippet folder, is a snippet.html
3. Copy the code into the documentation. It's probably good to add some newlines to make it clearer where to paste the API key.