This project includes frontend. To begin, install dependencies:
- Node.js v16.15.0 or latest stable. We recommend using nvm to install.
- PNPM v7.1.7 or latest stable
- Docker v0.8.2 or latest stable
- Docker Compose v2.6.0 or latest stable
- Visit the Fuel Wallet 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-walletpnpm installIn this step, we are going to;
- launch a local
fuel-corenode; - launch a local
faucetAPI;
pnpm node:dev startStart a local development frontend. After running the below command you can open http://localhost:3000 in your browser to view the frontend.
pnpm devThis section has a brief description of each directory. More details can be found inside each package, by clicking on the links.
- packages/app Frontend Fuel Wallet application
- packages/config Build configurations
- packages/fuelhat Fuel Wallet scripts CLI
- packages/mediator Mediator is a PubSub library we use to better integrate XState machines and also other relevant event-driven issues.
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:
pnpm <command name>| Script | Description |
|---|---|
dev |
Run development server for the WebApp packages/app. |
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.test if the file exists).
To run tests use:
pnpm test