Installation

A comprehensive guide to installing and running Nexus UI on your local machine. Start your Web3 project with a solid foundation.

System Requirements

  • Node.js version 18.17 or later.
  • Git installed on your machine.
  • A Web3 Wallet extension (MetaMask/Rabby) in your browser for testing.
1

Clone the Repository

The fastest way to get started is by using create-next-app targeting the Nexus UI template repository. Open your terminal and run the following command:

Terminal
npx create-next-app -e https://github.com/zonafirman/web3-nexus-template my-dapp
cd my-dapp

This command will download the template and create a new folder named my-dapp.

2

Install Dependencies

Choose your preferred package manager to install the required dependencies.

Terminal
npm install
3

Environment Variables

Since this is a Web3 application, you will need a Project ID for WalletConnect or RPC Keys. Copy the .env.example file to .env.local.

Terminal
cp .env.example .env.local

Open .env.local and fill in the following variables:

.env.local
NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID="your_project_id_here"
NEXT_PUBLIC_ALCHEMY_API_KEY="your_alchemy_key_here"

Important: Never upload your .env.local file to GitHub (it is already ignored in your .gitignore file).

4

Run Development Server

You are all set! Run the local development server to see the final result.

Terminal
npm run dev

Open http://localhost:3000 in your browser to see the result.

Previous IntroductionNext StepConfiguration