diff --git a/packages/minting-backend/sdk/README.md b/packages/minting-backend/sdk/README.md index 00f4911a7c..470f6aa94e 100644 --- a/packages/minting-backend/sdk/README.md +++ b/packages/minting-backend/sdk/README.md @@ -1,3 +1,56 @@ # Minting backend +### Pre-requisites + +Install dependencies for the workspace + +```bash +yarn install +``` + +### Quick Start Guide + +All commands below need to be run in the context of the `minting-backend` package where this README is located. Read more about context [here](../../../README.md#context). + +Running in `dev` mode: + +```bash +yarn dev +``` + +Building to `./dist` directory with javascript output: + +```bash +yarn build +``` + +Running all tests: + +```bash +yarn test +``` + +Running changed tests in watch mode: + +```bash +yarn test:watch +``` + +Linting: + +```bash +yarn lint +``` + +Typechecking: + +```bash +yarn typecheck +``` + + +### About + This package provides backend code for integrating [Immutable Minting API](https://docs.immutable.com/docs/zkEVM/products/minting/minting-api). + +[Read more about the minting-backend package here](../../../README.md#minting-backend) \ No newline at end of file diff --git a/packages/minting-backend/sdk/package.json b/packages/minting-backend/sdk/package.json index 4f4cd592df..f0508b3975 100644 --- a/packages/minting-backend/sdk/package.json +++ b/packages/minting-backend/sdk/package.json @@ -40,7 +40,7 @@ "dev": "rollup --config rollup.config.js -w", "lint": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0", "test": "jest --passWithNoTests", - "test:e2e": "jest --runInBand --testMatch \"**/?(*.)+(e2e).[jt]s?(x)\"", + "test:watch": "jest --watch", "typecheck": "tsc --noEmit --jsx preserve" }, "type": "module",