Requirements

• Node 12
  • Use NVM or NVM-Windows to manage NodeJS versions on your machine
• Docker
• MetaMask Chrome Plugin

Getting Started

• npm install && npm run bootstrap to install all dependencies
• Create .env and truffle/.env. Use the .env.example files as starting point.
• Start database container by running docker-compose up -d db
• Start local blockchain by running npm run blockchain
• Deploy contract on local blockchain by running npm run deploy
• Start frontend and backend by running npm run dev
• Configure MetaMask
  • Import contract owner account in MetaMask (private keys are logged in npm run blockchain)
  • Connect to local test network in MetaMask
• Open http://localhost:8080/ in Chrome
• Use the blue button in the menu bar to connect your wallet

Tech Stack

• NestJS backend (TypeScript)
  • MySQL database Docker container
  • Web3 v1
• Vue v3 (JavaScript)
  • Tailwind CSS framework
  • HeadlessUI components
  • Vue Router v4
  • HeroIcons
  • Web3 v1
  • Vuex v4
• Ethereum development environment
  • Hardhat for local blockchain deployment
  • Alchemy for deployment to test networks