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:
- Visit the Fuel Wallet Icon Link repo and fork the project.
- Then clone your forked copy to your local machine and get to work.
git clone https://github.com/FuelLabs/fuels-wallet
cd fuels-wallet
cp packages/app/.env.example packages/app/.env
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
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.
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 Icon Link. These are some of the most used during development:
Script | Description |
|---|
dev
| |
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. |
Icon InfoCircle
Other scripts can be found in
package.json Icon Link.
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.test if the file exists).
Before running test, make sure a local test node is running:
Then, to run tests use:
To run E2E tests, follow these steps:
NODE_ENV=test pnpm build:app
NODE_ENV=test pnpm test:e2e