Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koheimizuno/web3-turbo
⚡ A monorepo starter kit for building blockchain-based applications with ease
https://github.com/koheimizuno/web3-turbo
ethereum-dapp ethersjs hardhat nextjs react smart-contracts solidity tailwindcss turborepo typescript wagmi web3
Last synced: 20 days ago
JSON representation
⚡ A monorepo starter kit for building blockchain-based applications with ease
- Host: GitHub
- URL: https://github.com/koheimizuno/web3-turbo
- Owner: koheimizuno
- License: mit
- Created: 2024-09-18T15:49:21.000Z (2 months ago)
- Default Branch: dev
- Last Pushed: 2024-09-18T15:58:46.000Z (2 months ago)
- Last Synced: 2024-10-28T07:18:39.072Z (22 days ago)
- Topics: ethereum-dapp, ethersjs, hardhat, nextjs, react, smart-contracts, solidity, tailwindcss, turborepo, typescript, wagmi, web3
- Language: TypeScript
- Homepage:
- Size: 3.65 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# 📦 Create web3 turbo
This boilerplate is based on [Turborepo](https://github.com/vercel/turborepo).
It uses [Yarn](https://classic.yarnpkg.com/lang/en/) as a package manager. It includes the following packages/apps:
## Installation
There are two ways of initializing an app using `create-web3-turbo` starter. You can either use this repository as a template or use Turbo's CLI to init your project:
### Apps and Packages
- `web`: A [Next.js](https://nextjs.org) based app with typescript,wagmi,rainbowkit,ether.js
- `contracts`: hardhat,typescript,chai,ethers
- `storybook`: storybook
- `ui`: a custom shared ui component library
- `lib`: sdk library for core instances
- `config`: lint and common config configurations
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
- `husky`: lint staged pre-commit check
It uses [Turborepo](https://turborepo.org/) and contains:
```
.github
└─ pull_request_template
└─ workflows
└─ CI
.vscode
└─ Recommended extensions and settings for VSCode users
apps
├─ contracts
|
└─ web
|
└─ storybook
packages
├─ config
| └─ lint config
├─ lib
└─ sdk library for core instances
└─ ui
└─ a custom shared ui component library
```
### Stack
This starter kit contains:
- [Next.js](https://nextjs.org) framework
- [WAGMI Hooks](https://github.com/tmm/wagmi) advanced web3 react hooks
- [ethers.js](https://github.com/ethers-io/ethers.js) integrate with blockchain
- [Tailwind](https://tailwindui.com/) Utility-First Fundamentals
- [Typechain](https://github.com/dethcrypto/TypeChain) to keep those end-to-end types generated from ABIs
- [Hardhat](https://hardhat.org/) Deploy && compile smart Contracts
### NOTE:
I recommend the following extension to make it easy to switch among packages in your mono repo, as well as open multiple under a single workspace. It makes mono repos work well with the test explorer extension.
link: https://marketplace.visualstudio.com/items?itemName=folke.vscode-monorepo-workspace
## Get started
```
cd turborepo-web3-starter-kit
yarn install
```
### Front-end
```
yarn dev
```
### Smart Contracts
```
yarn hardhat:compile
yarn hardhat:node
yarn hardhat:test
```
### Story Book
```
yarn storybook
yarn build-storybook
```
### Docker
This repo is configured to be built with Docker, and Docker compose. To build all apps in this repo:
```
# Create a network, which allows containers to communicate
# with each other, by using their container name as a hostname
docker network create app_network
# Build prod using new BuildKit engine
COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose -f docker-compose.yml build --parallel
# Start prod in detached mode
docker-compose -f docker-compose.yml up -d
```
Open http://localhost:3000.
To shutdown all running containers:
```
# Stop all running containers
docker kill $(docker ps -q) && docker rm $(docker ps -a -q)
```