Skip to content

Commit

Permalink
Docs: [DX-2927] Update README of "minting-backend" package (#1898)
Browse files Browse the repository at this point in the history
  • Loading branch information
zaidarain1 authored Jun 14, 2024
1 parent 66f7fca commit b5ac329
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 1 deletion.
53 changes: 53 additions & 0 deletions packages/minting-backend/sdk/README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion packages/minting-backend/sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit b5ac329

Please sign in to comment.