changed 3 years ago  
Linked with GitHub

🏗 Scaffold-Grants

Intro

This repo is an implementation of the Gitcoin grant codebase using scaffold-eth. The goal of the project is to create mutual aid financing for projects made by the BuidlGuidl.

TODO

BlockEnd

  • Fix dependencies on gitcoin codebase
  • Deploy codebase and go over functions
  • Review features to be used in 1st round

FrontEnd

  • Create Landing page/branding for Scaffold-Grants product
  • Develop visual guide for webpage/brand
  • Implement UX changes

Community

  • Organize BuidlGuild
    • Recruit core dev team
    • Start onboarding teams/projects for NerdCon
  • NerdCon
    • What is it? -> BuidlGuild Hackathon in gather
    • Lets find speakers!
    • Create event posters
    • Decorate NerdCon
    • Help creating project kiosks

Reach out to At0xNQ on telegram to join in!

dgrants

Directory Structure

.
├── app                     # Frontend Vue.js application
├── contracts               # Smart contracts
├── doc                     # Project documentation including the protocol definition
├── lerna.json              # Lerna config
├── package.json            # Root package configuration
├── tsconfig.json           # Typescript configuration
├── tsconfig.settings.json  # Typescript configuration
├── types                   # Shared types
├── vetur.config.js         # Vetur configuration
├── yarn.lock               # Yarn lock file
└── README.md

Typescript

This is the typescript repo of scaffold-eth and it uses hardhat and vite to run scaffold-eth-typescript. There is also a nextjs version. The directories that you'll use are:

packages/vite-app-ts/
packages/hardhat-ts/
packages/next-app-ts/

Quick Start

Commands to run the app

Running the app

  1. install your dependencies, open a new command prompt

    ​​​yarn install

  2. start a hardhat node

    ​​​yarn chain

  3. run the app, open a new command prompt

    ​​​# build hardhat & external contracts types
​​​yarn contracts:build
​​​# deploy your hardhat contracts
​​​yarn deploy
​​​# start the app (vite)
​​​yarn start

  4. If you'd like to run the nextjs app, open a new command prompt

    ​​​# start nextjs app
​​​yarn start:nextjs

  5. other commands

    ​​​# rebuild all contracts, incase of inconsistent state
​​​yarn contracts:rebuild
​​​# run hardhat commands for the workspace, or see all tasks
​​​yarn hardhat 'xxx'
​​​# get eth for testing locally
​​​yarn hardhat faucet xxx
​​​# run any subgraph commands for the workspace
​​​yarn subgraph 'xxx'

    Other folders

    ​​​# for subgraph
​​​packages/advanced/subgraph/
​​​packages/advanced/services/

Environment Variables

Vite and NextJs app folders have .env files. To create local variables that overrride these, create a file called .env.local, or .env.development.local or .env.production.local and put your overrides in there.

You can set your TARGET_NETWORK with them.

Overview

Everything you need to build on Ethereum! 🚀 Quickly experiment with Solidity using a frontend that adapts to your smart contract:

image

  • 🔏 Edit your smart contract YourContract.sol in packages/hardhat-ts/contracts
  • 📝 Edit your frontend MainPage.tsx in packages/vite-app-ts/src
  • 💼 Edit your deployment scripts in packages/hardhat-ts/deploy
  • 📱 Open http://localhost:3000 to see the app
  • 👷🏽‍♂️ run yarn hardhat to get a list of all the tasks. Run yarn hardhat taskname to run the task.




Guides

Documentation

🏃💨 Speedrun Ethereum

Register as a builder here and start on some of the challenges and build a portfolio.

🏁 Make sure to click on the typescript tab!




More Information!

📚 Documentation

Documentation, tutorials, challenges, and many more resources, visit: docs.scaffoldeth.io

Eth-hooks documentation is here. Learn how to use the contexts here.

💬 Support Chat

Join the telegram support chat 💬 to ask questions and find others building with 🏗 scaffold-eth!

🛠 Buidl

Check out

🔭 Learning Solidity

Read the docs: https://docs.soliditylang.org

Go through each topic from solidity by example editing YourContract.sol in 🏗 scaffold-eth

🙏🏽 Support us!

Please check out our Gitcoin grant too!

🔐 P.S.About keys

You need an RPC and API keys for testnets and production deployments, create an Alchemy account and replace the value of ALCHEMY_KEY = xxx in packages/vite-app-ts/.env or packages/next-app-ts/.env with your new keys.

Select a repo