Setup Guide to run Plutus application using PAB services

This setup guide shows how to deploy a simple, "smart contract" application bundled with Plutus Application Backend (PAB) services.

Hopefully, this documentation provides a lot of value for others. The contributors of this project welcome your feedback-- both good and bad!

Why is this useful?

• TODO

Key Details

• The smart-contract application code is taken from the IOHK Plutus Starter repository. It is a simple guessing game with lock and guess endpoints.
• Client wallets interact with the application by invoking HTTP endpoints via the PAB Web Server.
• The PAB services connect to a Cardano Testnet for on-chain transaction activity

Medium article

• TODO

Usage Instructions

1. Install executables

   • Install the following executables: cardano-node, cardano-wallet, plutus-chain-index
   • Please refer to the Install executables guide for instructions.

2. Build sample app and PAB package dependencies

   • Build the PAB services bundled with the sample contract into one executable.
   • Please refer to the Build Application Bundle guide for instructions to set up.

3. Start all the backend services and the PAB webserver bundled with contracts

   • Start a relay node pointing at Cardano testnet, cardano-wallet API server, chain-index and the bundle Application code
   • Please refer to the Start Services guide for instructions.

4. Interact with the application

   • Set up 2 user wallets and interact with the contract to verify it works
   • Please refer to the Use PAB endpoints guide for instructions.

Contributors

This project is provided free of charge to the Cardano community. The author of this project is a fan of Cardano, as well as a Cardano stake pool operator. I am not affiliated with IOHK in any official capacity.

If you want to support the continued development of this project, you can delegate or recommend my staking pool:

• WOOF Cardano Staking Pool

Contributing

If you'd like to help maintain this project, please feel free to submit a pull request. Please ensure that any script changes have been tested and verified.

License

This project is licensed under the terms of the MIT License.