The ProcessOut's full API documentation can be found on our documentation. You can also find ProcessOut.js specific documentation for Card tokenization setup, Dynamic Checkout and Embedded/Native APMs.
- Node.js (v18.17.1)
- Yarn (v1.22.22)
To develop ProcessOut.js locally you need to install the dependencies by running the following command:
yarn installIt will install all the dependencies needed to run the project in development mode, lint, format and build it.
To build the project to get final processout.js and modal.js scripts, run the following command:
yarn buildIt will create the dist folder with the final scripts.
To bump the version of ProcessOut.js, run the following command:
yarn bump-version --patch or yarn bump-version --minor or yarn bump-version --major or yarn bump-version and specify the version you want to bump to.
This will bump the version of the project inside the package.json file and create Git tag and commit with the new version. The version will then append to the dist/processout.js and dist/modal.js files when building the project and will be used to identify the version of the ProcessOut.js with every request to the ProcessOut API. Keep in mind that this is just internal versioning for logging purposes, it doesn't affect how merchants use the ProcessOut.js.
Every time you make a change to the project with new features or bug fixes, you should bump the version of the project.
To run the development environment, run the following command:
yarn devThis will start the development server and the TypeScript compiler in watch mode. The development server will be available at http://localhost:3000. Every change you make will be reflected in the browser automatically.
To run the tests, run the following command:
yarn testTo run the linting, run the following command:
yarn lintTo run the formatting, run the following command:
yarn formatThis will format the code according to the Prettier rules.