Icon ArrowRight Getting Started
Icon ArrowRight Connecting
Icon ArrowRight Accounts
Icon ArrowRight Assets
Icon ArrowRight Sending a Transaction
Icon ArrowRight Signing a Message
Icon ArrowRight Networks
Icon ArrowRight ABIs
Icon ArrowRight Wallet Connectors
Icon ArrowRight API Reference
Icon ArrowRight Hooks Reference
Icon ArrowRight Playwright Utils

Icon ArrowRight Running locally
Icon ArrowRight Contributing Guide
Icon ArrowRight Linking local dependencies

Docs Icon ChevronRight Contributing Icon ChevronRight Running locally

Running locally

This is a guide that will show you how you can run this project locally if you want to test or make contributions to our Fuel Wallet SDK.

Running the project

Requirements

This project includes frontend. To begin, install dependencies:

Node.js 20.14.0 or latest stable Icon Link. We recommend using nvm Icon Link to install.
pnpm v9.10.0 or latest stable Icon Link
Docker v0.8.2 or latest stable Icon Link
Docker Compose v2.6.0 or latest stable Icon Link

Getting the Repository

Visit the Fuel Wallet Icon Link repo and fork the project.
Then clone your forked copy to your local machine and get to work.

1git clone https://github.com/FuelLabs/fuels-wallet
2cd fuels-wallet

Install Dependencies

1pnpm install

Setup Environment Variables

1cp packages/app/.env.example packages/app/.env

Run Local Node

In this step, we are going to;

launch a local fuel-core node;
launch a local faucet API;

Make sure you have docker installed and running, before running the command below

1pnpm node:up

Run Web App

Start a local development frontend. After running the below command you can open http://localhost:3000 Icon Link in your browser to view the frontend.

1pnpm dev

Project Overview

This section has a brief description of each directory. More details can be found inside each package, by clicking on the links.

packages/app Icon Link Frontend Fuel Wallet application
packages/config Icon Link Build configurations

Useful Scripts

To make life easier we added as many useful scripts as possible to our package.json Icon Link. These are some of the most used during development:

1pnpm <command name>

Script	Description
`dev`	Run development server for the web app packages/app Icon Link
`dev:storybook`	Run storybook, which is the place we use to develop our components.
`test`	Run all units tests that are based on Jest.
`test:e2e`	Run all E2E tests that are based on Cypress.

Other scripts can be found in package.json Icon Link.

Running Tests

Please make sure you have done these steps first:

Getting the Repository Icon Link
Install Dependencies Icon Link
Run Local Node Icon Link

Run Tests in Development Mode

All tests are run against the local node configured in the files packages/app/.env (or packages/app/.env.example if the file exists).

Before running test, make sure a local test node is running:

1pnpm node:up

Then, to run tests use:

1pnpm test

Running E2E Tests

To run E2E tests, follow these steps:

Run Tests E2E in Development Mode

1pnpm node:up

1pnpm dev:crx

1pnpm test:e2e

Run Tests E2E in CI/TEST env Mode

1pnpm node:up

1NODE_ENV=test pnpm build:app

1NODE_ENV=test pnpm test:e2e