The Tezos starter kit provides a truffle box with reasonable defaults to kick start your smart contract development experience. It includes a ready to use archive sandbox node with RPC & CORS configured.

• Docker - used to run a local Tezos node together with the LIGO compiler (If you're on linux, follow the post-installation steps as well)
• Node.js - Javascript runtime environment that we'll use for testing and deployment
• truffle@tezos - Testing framework, originally built for Ethereum that now includes support for Tezos. It can be installed by running:

npm i -g truffle@tezos

Unbox the starter kit & install the dependencies

$ git clone https://github.com/stove-labs/tezos-starter-kit
$ cd tezos-starter-kit
$ npm i

Compile the example contract

$ npm run compile

Start the local sandbox node

$ npm run start-sandbox -- carthage

Migrate the compiled contracts

$ npm run migrate

Run the contract tests

$ npm run test

Archive mode sandbox Tezos node is provided within this box with RPC exposed at port 8732 and with two accounts that are generously funded.

You can start a sandbox with a specific protocol by passing an additional argument to the sandbox commands, e.g. babylon or carthage

$ npm run start-sandbox -- carthage
$ npm run kill-sandbox -- carthage
$ npm run restart-sandbox -- carthage

In order to use your migration scripts with a different network than your local sandbox, you can specify an optional --network argument.

Make sure to claim a new account at the faucet, and replace the faucet.json file with the new one downloaded previously.

$ truffle migrate --network carthagenet