Skip to content

Dapp starter kit using: Buidler + Waffle + TypeChain + OpenZeppelin CLI + Vue (TypeScript)

Notifications You must be signed in to change notification settings

raid-guild/buidler-waffle-typechain-oz-vue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Buidler + Waffle + TypeChain + OpenZeppelin CLI + Vue (TypeScript)

Inspired by The New Solidity Dev Stack: Buidler + Ethers + Waffle + Typescript, this is a pre-configured starter kit that uses the latest and greatest tool set to go from zero to hero 💪 in a quarter of the time, with 10x the type safety 🛡️ and debugging 🐞 capabilities.

Leverage best practice tools such as: Buidler 🔨 for stack traces and console.log in contracts, TypeChain 🔗 for contract and front end type definitions, Waffle 🥞 for type safe ethers.js contract testing, and Vue with TypeScript/TypeChain support 🎀 to round out the stack.

If that's not enough: hit the ground running with test driven development 🧪 following the examples provided for contract, unit, and end to end testing. Objectively know when functionality is complete ✅ while catching bugs in updates before releasing.

As an added bonus: easily deploy upgradeable contracts - where one can update their contract logic 📝 while maintaining its state 🔒 - using the built-in OpenZeppelin CLI. Never worry about migrating again!

Finally, there's lots of under the hood goodies that come pre-configured to build beautiful Progressive Web Apps 🦋 that include state management and routing; with more features being released rapidly!

Next on deck: gasless transactions ⛽🔥

Ready to develop like the pros? Use this template to get started! 🚀

Using the template

Once you've generated a project and cloned it locally:

Install the dependencies

yarn

Compile and generate type definitions for your contracts

yarn build:contracts

Run your Waffle tests with stack traces

yarn test:contracts

Start the frontend app in development mode (hot-code contract reloading, revert reporting, etc.)

yarn start:node

and in a new terminal

yarn start:dev

then open the app running locally in your favorite browser.

Upgrade your contracts locally

yarn upgrade:local

Start the frontend sans a local blockchain

yarn start:web

Lint and fix files

yarn lint

Build the dApp for production

yarn build

Run your unit tests

yarn test:unit

Run your end-to-end tests

yarn test:e2e

Run ALL the tests!

yarn test

Customize Vue configuration

See Configuration Reference.

Other Documentation