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.
This project includes frontend. To begin, install dependencies:
1git clone https://github.com/FuelLabs/fuels-wallet
2cd fuels-wallet
1pnpm install
1cp packages/app/.env.example packages/app/.env
In this step, we are going to;
fuel-core
node; faucet
API; Make sure you have docker installed and running, before running the command below
1pnpm node:up
Start a local development frontend. After running the below command you can open http://localhost:3000 in your browser to view the frontend.
1pnpm dev
This section has a brief description of each directory. More details can be found inside each package, by clicking on the links.
To make life easier we added as many useful scripts as possible to our package.json
. These are some of the most used during development:
1pnpm <command name>
Script | Description |
---|---|
dev | Run development server for the web app packages/app |
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
.
Please make sure you have done these steps first:
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
To run E2E tests, follow these steps:
1pnpm node:up
1pnpm dev:crx
1pnpm test:e2e
1pnpm node:up
1NODE_ENV=test pnpm build:app
1NODE_ENV=test pnpm test:e2e