GETTING_STARTED.md

Getting Started

Requirements

This project includes both frontend and contracts. To begin, install dependencies:

• Node.js v18.14.1 or latest stable. We recommend using nvm to install.
• PNPM v7.18.2 or latest stable
• Rust toolchain v0.16.0 or latest stable
• Forc v0.33.1
• Docker v20.0.21 or latest stable
• Docker Compose v2.13.0 or latest stable

Running Project Locally

📚 - Getting the Repository

1. Visit the Fuel Portal repo and fork the project.
2. Then clone your forked copy to your local machine and get to work.

git clone https://github.com/FuelLabs/fuels-portal
cd fuels-portal

📦 - Install Dependencies

pnpm install

📒 - Run Local Node

In this step, we are going to;

• launch a local fuel-core node;

pnpm node:start

To stop the node, run:

pnpm node:stop

💻 - Run Web App

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

pnpm 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 Frontend application
• packages/config Build configurations
• docker Network configurations

🧰 Useful Scripts

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.
services:stop	Stop and remove all development containers that are running locally.
services:start	Run the local network with fuel-core and the faucet API.

Other scripts can be found in package.json.

Run Tests

To run all tests against the node and contract configured in packages/app/.env (or packages/app/.env.test if the file exists):

pnpm test