https://github.com/iotexproject/scaffold-iotex
Tutorials for machinefi dapps
https://github.com/iotexproject/scaffold-iotex
Last synced: 4 months ago
JSON representation
Tutorials for machinefi dapps
- Host: GitHub
- URL: https://github.com/iotexproject/scaffold-iotex
- Owner: iotexproject
- License: mit
- Created: 2022-01-26T15:46:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-27T09:31:35.000Z (over 3 years ago)
- Last Synced: 2025-05-08T22:12:36.248Z (about 1 year ago)
- Language: TypeScript
- Size: 458 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scaffold-IoTeX
Everything you need to start building on IoTeX, by tutorials!
# steps to start
## clone this repo
```bash
git clone https://github.com/iotexproject/scaffold-iotex.git
cd scaffold-iotex
yarn install
```
## add private key
From `scaffold-iotex` dir run
```bash
touch ./packages/hardhat/.env
```
open created .env file and add the following string
```txt
PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
```
and change private key for one that you own.
This account will be used to deploy contracts and run scripts on network you choose. Make sure you have some IOTX on this account.
## deploy
Firstly run
```bash
yarn compile
```
to have contract types generated for you. Next run
```bash
yarn test
```
, it will run simple test on hardhat network. If all test are passed you can run
```bash
yarn deploy
```
to deploy contracts on iotex testnet or
```bash
yarn deploy-mainnet
```
to deploy contracts on iotex mainnet. If contracts were deployed successfully, you will find info about deployed contracts (abi and addresses)
## start client
After deploying your smart contracts, from `scaffold-iotex` dir run
```bash
yarn dev
```
or
```bash
yarn build
yarn start
```
It will start a server on http://localhost:3000/. You will be able to open your dapp in a browser.
There you will be able to see balances and transfer your PBL.
## customize the app in any way you want
any contributions to the code are welcomed!