This project includes both frontend and contracts. To begin, install dependencies:
- Node.js v20.11.0 or latest stable. We recommend using nvm to install.
- PNPM v7.18.2 or latest stable
- Docker v20.0.21 or latest stable
- Docker Compose v2.15.1 or latest stable
- Rust v1.68.2 or latest
stable - Forc v0.37.1 with latest toolchain with forc index version v0.8.0
- Visit the Fuel Explorer repo and fork the project.
- Then clone your forked copy to your local machine and get to work.
git clone https://github.com/FuelLabs/fuel-explorer
cd fuel-explorerpnpm installThis command will start all the development services;
- It will start a
fuel-corelocal node; - It will start the explorer
graphqlAPI;
pnpm dev
This section has a brief description of each directory. More details can be found inside each package, by clicking on the links.
- packages/app Frontend application
- packages/graphql Explorer Graphql API
- docker Network and postgres
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 |
|---|---|
node:start |
Run the local network with fuel-core and the faucet API. |
node:stop |
Stop all containers without removing data |
node:clean |
Stop and remove all development containers that are running locally. |
node:restart |
Restart all containers without removing data |
Other scripts can be found in package.json.