-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
66f7fca
commit b5ac329
Showing
2 changed files
with
54 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters