Web3 Template is a boilerplate for developing Ethereum based projects. This repository uses Turborepo to manage multiple projects and packages in a single repo, and currently consists of two parts:
- A Foundry smart contract project
- A Next.js frontend that lets the user interact with the smart contracts
Before getting started, we suggest reading our Contributing Guidelines.
You'll need the following tools to run the entire application locally.
FONTAWESOME_NPM_AUTH_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX yarn install
You can now run the install command to download all dependencies and run the application locally. Warning: you might have to change some variables in the env files for the applications to work fully.
$ yarn install
# Copy the environment variables
$ cp ./apps/web/.env.example ./apps/web/.env.local
Running the application can be done using the following commands.
# Run the entire website locally (requires Docker)
$ yarn dev
# Run the web and all its dependency jobs
$ yarn turbo run dev --filter=web...
Tests can be executed using the following commands:
# Run all tests
$ yarn test
# Only run the tests for contracts project
$ yarn turbo run test --filter=contracts...
Pull requests are welcome. See the contribution guidelines for more information.