Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Latest commit

 

History

History
54 lines (32 loc) · 3.02 KB

README.md

File metadata and controls

54 lines (32 loc) · 3.02 KB
Raw

Overview

Web3 starter kit gives developers the simplest and quickesrt way to start a Web3 project with a web client, API, and contracts. With a minimalist and web3 focused structure the kit offers a flexible template anyone can easily modify to fit their use case. The kit has different branches that provide more complex functionality out the gate such as Mud for autonomous worlds and Tokenbound accounts.

Getting Started

The repo is a monorepo using pnpm with all code held under packages directory. Packages consists of API, Clients, and Contracts and can be ran simultonolesouly E2E in a local environment.

In order to run this project you need these dependencies:

  • Node version 18+ for running scripts and PNPM.
  • PNPM version 6+ for package management.
  • Docker for database services Postgres and Redis.
  • Foundry for compiling/deploying smart contracts and running local blockchain node.

Tests

Test can be ran at both the package level and root with pnpm run test.

Testing Structure:

  • Clients use vitest and testing library for writing and running tests
  • Contracts tests are written in Solidity and ran via MUD which uses Foundry's Forge for running tests.

Architecture

The repo is architected with packages holding different code for dirrefent aspect of an application from clients to contracts. API and contract packages are singletons while clients may hold multiple for different interfaces (web, mobile)

Languages used:

  • Typescript - Used for both client and API code with a types folder holding global type declerations and types created directly in routes, hooks, components, and views.
  • Solidity - Language for writing Ethereum based contracts, compiling, and deploying.

Core libraries:

  • React - Library for rendering UI and controlling basic state
  • Vite - Build library for client UIs

Contributing

Project is open sourced and open for contributors who want to help add new feqtures to the kit.

If you would like to contribute here are the following steps:

  • Fork the repo and get your local environment up and running, if any issues post in the issues tab.
  • Pick up an open needs help issue from the issues that's not in progress and create a branch with the issue name.
  • Once done open a PR to merge into the development branch of the starter kit repo
  • Once approved make sure your branch is up to date with main and complete the merge.

test

forge test --fork-url https://base-sepolia-rpc.publicnode.com -vvvv