scaffold-eth-typescript

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

scaffold-eth-typescript

★ 179 Open GitHub ↗

Typescript version of Scaffold-Eth 🏗

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🏗 Scaffold-Eth Typescript

# NOTE: Use Scaffold-Eth-2

### Pease use https://github.com/scaffold-eth/scaffold-eth-2 for a modern v2 version of scaffold-eth-typescript!  It has been entire rebuilt with typescript from the ground up!

----

## Features

This is the typescript repo of scaffold-eth. Use scaffold-eth-typescript with:

- A react frontend running with `nextjs` or `vite`.
- Solidity toolkit of `hardhat` or `foundry`
- It has the a command line system that allows you to choose a **react frontend** or **solidity toolkit**

## Quick Start

### Fork or clone the repo

- You can use the use the template link: [scaffold-eth-typescript template](https://github.com/scaffold-eth/scaffold-eth-typescript/generate)
- You can clone the repo with git
  ```bash
  git clone https://github.com/scaffold-eth/scaffold-eth-typescript.git
  ```

### Starting the App

Running the app

1. install your dependencies, `open a new command prompt`

```bash
   yarn install
   ```

2. Create a default `scaffold.config.json` configuration file

```bash
   yarn create-config
   ```

3. start a local hardhat node (chain)

```bash
   yarn chain
   ```

4. Run the app, `open a new command prompt terminal`

```bash
   # in a new terminal
   # compile your contracts
   yarn compile
   # deploy your hardhat contracts
   yarn deploy
   # start the react app (vite)
   yarn start
   ```

5. Open http://localhost:3000 to see your front end

## Configuration

Scaffold uses `scaffold.config.json` as a configuration file located in `/packages/common/scaffold.config.json`. You can create the config file by running the command `yarn create-config`.

### Command line help

```bash
use `-h` with any command for help.  e.g. yarn set-react -h
```

### Configure react and solidity toolkit

You can change the configuration file to pick different frontends and solidity toolkits.

```bash
yarn set-react `nextjs` or `vite`
yarn set-solidity `hardhat` or `foundry`
```

### Target network

Set your `targetNetwork` in the config. This is the network the solidity toolkit is deploying against.

Set your `availableNetworks` in the config. This is the networks the frontend is available in.

You can configure it from the **config file** or from **command line**.

```bash
yarn set-network -h
yarn set-network 'localhost' 'localhost, mainnet'
```

### More commands

You can see all the other commands by using `yarn scaffold`

## Solidity Tookits Details

### Hardhat

Everything will be installed with `yarn install`.

You can use hardhat with right context using

```bash
yarn hardhat
```

### Foundry

Make sure you install foundry

1. Make sure you install foundry first. Use `curl -L https://foundry.paradigm.xyz | bash` to install foundryup

> You can see more details here. https://book.getfoundry.sh/getting-started/installation

2. Run `yarn install:foundry` to install or update foundry in the right folder. It will also run _forge install_ automatically with the right context.

You can use foundry commands with the right context

```bash
yarn forge
yarn anvil
yarn cast
```

## Directories

The directories that you'll use are:

```bash
packages/solidity-ts/

And one of either:
packages/vite-app-ts/
packages/next-app-ts/
```

### More Info

Other commands

```bash
# rebuild all contracts, incase of inconsistent state
yarn contracts:clean
yarn contracts:build
# run hardhat commands for the workspace, or see all tasks
yarn hardhat 'xxx'
# run forge, anvil or
yarn forge
yarn anvil
yarn cast
```

Other folders

```bash
# for subgraph checkout README.md in following directories
packages/subgraph/
packages/services/
```

## Guides

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

![image](https://user-images.githubusercontent.com/2653167/124158108-c14ca380-da56-11eb-967e-69cde37ca8eb.png)

- 🔏 Edit your smart contract `YourContract.sol` in `packages/solidity-ts/contracts`
- 📝 Edit your frontend `MainPage.tsx` in `packages/vite-app-ts/src`
- 💼 Edit your deployment scripts in `packages/solidity-ts/deploy/hardhat-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.

---

# Documentation

Check out [eth-hooks docs](https://scaffold-eth.github.io/eth-ui) for example of how to use hooks

## Video Tutorials

Tutorial using the CLI

- [Scaffold-eth-typescript Tutorial: Foundry, NextJS, CLI](https://www.youtube.com/watch?v=bEd6wV2H28g)

Eth-hooks v4 & scaffold-eth-typescript overview

- [Getting Started with eth-hooks and scaffold-eth-typescript](https://www.youtube.com/watch?v=a7W9nTX8qLk&t=3s)
- [eth-hooks v4](https://www.youtube.com/watch?v=STxAdE8wQwY&t=86s)

## 🏃💨 Speedrun Ethereum

> 🏁 Make sure to click on the typescript tab!

---

# Extra!

## 💬 Support Chat

Join the telegram [support chat 💬](https://t.me/joinchat/KByvmRe5wkR-8F_zz6AjpA) to ask questions and find others building with 🏗 scaffold-eth!

## 🛠 Buidl

Check out

- [Typescript challenges](https://github.com/scaffold-eth/scaffold-eth-typescript-challenges)
- [Typescript examples](https://github.com/scaffold-eth/scaffold-eth-typescript-examples)
- [Vanilla JS active branches](https://github.com/scaffold-eth/scaffold-eth/branches/active)
- Join/fund the 🏰 [BuidlGuidl](https://BuidlGuidl.com)!

### 🙏🏽 Support us!

Please check out our [Gitcoin grant](https://gitcoin.co/grants/2851/scaffold-eth) too!

scaffold-eth-typescript

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README