GithubHelp home page GithubHelp logo

web3-template's Introduction

Web3 template

CI

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

Getting Started

Before getting started, we suggest reading our Contributing Guidelines.

Prerequisites

You'll need the following tools to run the entire application locally.

FONTAWESOME_NPM_AUTH_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX yarn install

Installation

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

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...

Contributing

Pull requests are welcome. See the contribution guidelines for more information.

web3-template's People

Contributors

jasperverbeet avatar rickvm avatar semantic-release-bot avatar

Stargazers

 avatar

Watchers

 avatar

web3-template's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.