https://github.com/OpenZeppelin/starter-kit-tutorial
An OpenZeppelin starter kit tutorial containing React, OpenZeppelin SDK & OpenZeppelin Contracts.
https://github.com/OpenZeppelin/starter-kit-tutorial
ethereum infura openzeppelin smart-contracts solidity
Last synced: 9 months ago
JSON representation
An OpenZeppelin starter kit tutorial containing React, OpenZeppelin SDK & OpenZeppelin Contracts.
- Host: GitHub
- URL: https://github.com/OpenZeppelin/starter-kit-tutorial
- Owner: OpenZeppelin
- License: mit
- Archived: true
- Created: 2019-05-14T19:17:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-05T17:34:46.000Z (over 5 years ago)
- Last Synced: 2024-11-25T09:43:25.711Z (over 1 year ago)
- Topics: ethereum, infura, openzeppelin, smart-contracts, solidity
- Language: JavaScript
- Homepage: https://openzeppelin.com/start
- Size: 4.8 MB
- Stars: 38
- Watchers: 8
- Forks: 26
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:warning: This project is **deprecated**. We are no longer actively developing new features nor addressing issues. Read [here](https://forum.openzeppelin.com/t/doubling-down-in-security/2712) for more info, and reach out if you are interested in taking over maintenance. We suggest looking into [create-eth-app](https://github.com/PaulRBerg/create-eth-app) for a popular alternative to this project.
# OpenZeppelin Starter Kit Tutorial
An OpenZeppelin Starter Kit Tutorial containing React, OpenZeppelin CLI, OpenZeppelin Contracts, and Infura.
This kit comes with everything you need to start using upgradeable Smart
contracts inside your applications. It also includes all the configuration
required to deploy to different networks.
In addition to the contents included in the [vanilla Starter Kit](https://github.com/OpenZeppelin/starter-kit/blob/master/README.md), this kit contains a step-by-step tutorial on how to use the OpenZeppelin SDK to develop your decentralized application.
## Requirements
Install Ganache.
```
npm install ganache-cli@6.7.0
```
## Installation
Ensure you are in a new and empty directory, and run the `unpack` command with `tutorial` to create a starter project:
```javascript
npx @openzeppelin/cli unpack tutorial
```
## Run
In a new terminal window, run your local blockchain:
```
ganache-cli --deterministic
```
In your original terminal window, at the top level of your folder, initialize the project
and follow the prompts:
```javascript
npx openzeppelin init
```
After that compile the contracts:
```javascript
npx openzeppelin compile
```
In a new terminal window, in the `client` directory, run the React app:
```javascript
cd client
npm run start
```
## Interact
You can interact directly with your smart contracts from the `openzeppelin` cli.
`npx openzeppelin transfer`
send funds to a given address.
`npx openzeppelin balance [address]`
query the ETH balance of the specified account, also supports ERC20s.
`npx openzeppelin send-tx`
sends a transaction to your contract and returns the events.
`npx openzeppelin call`
execute a constant method and receive back the value.
Type `npx openzeppelin` to see a complete list of availible commands.
## Test
This starter kit uses [Test Environment](https://github.com/OpenZeppelin/openzeppelin-test-environment/blob/master/README.md) for smart contracts tests. Tests are written with Mocha, [OpenZeppelin TestHelpers](https://github.com/OpenZeppelin/openzeppelin-test-helpers) and Web3.js. `./test/counter.js` and `./test/wallet.js` files are good starting point for writing your own tests.
```bash
npm run test
```
During development it is helpful to run `nodemon -e sol,js -x 'oz compile && npm test -- --bail'`. This will rerun tests on changes at `.sol` and `.js` files.
Jest is included for testing React components. Compile your contracts before running Jest, or you may receive some file not found errors.
```bash
// ensure you are inside the client directory when running this
npm run test
```
## Build
To build the application for production, use the build script. A production build will be in the `client/build` folder.
```javascript
// ensure you are inside the client directory when running this
npm run build
```
## Hot Loader
[Solidity Hot Loader](https://github.com/OpenZeppelin/solidity-loader) allows seamless updates to frontend by just editing and saving Solidity code. To enable change `disabled` flag in `client/config/webpack.js` file to `false`.
## FAQ
- **Where is my production build?**
The production build will be in the `client/build` folder after running `npm run build` in the `client` folder.
- **Where can I find more documentation?**
Check out the [OpenZeppelin Starter Kits documentation](https://docs.openzeppelin.com/starter-kits/).