Skip to content

iotaledger/wasp-dashboard

IOTA Wasp Dashboard

Discord StackExchange Apache-2.0 license

AboutPrerequisitesGetting startedSupporting the projectJoining the discussion

About

Dashboard for the 0.4.x-alpha+ Wasp node.

Prerequisites

To deploy your own version of the Node Dashboard, you need to have at least version 18 of Node.js installed on your device.

To check if you have Node.js installed, run the following command:

node -v

If Node.js is installed, you should see the version that's installed.

Getting Started

The dashboard is integrated into the common local-docker-setup by default.

If you need to run a local dev version of the dashboard, you need to run a Wasp node from the main branch using the local setup local-docker-setup

Then follow these steps:

  1. Install all needed npm modules via npm install.
  2. Create a .env.development file inside the repo root directory and configure the Wasp API url:
  • local-docker-setup node:
    • VITE_REACT_APP_WASP_API_URL=http://localhost/wasp/api
  • locally built node:
    • VITE_REACT_APP_WASP_API_URL=http://localhost:9090
  1. Run a dev-server instance by running npm start within the repo root directory.
  2. Using default port config, you should now be able to access the dashboard under http://127.0.0.1:5173/wasp/dashboard

The dashboard is hot-reload enabled.

Docker

If you want to run an official prebuilt version of the dashboard using docker, run the following command:

docker run -p 127.0.0.1:8080:80 -e WASP_API_URL="http://localhost:9090" iotaledger/wasp-dashboard

The WASP_API_URL might need to be changed depending on your setup.

  • local-docker-setup node:
    • WASP_API_URL=http://localhost/wasp/api
  • locally built node:
    • WASP_API_URL=http://localhost:9090

Supporting the project

If the Wasp Dashboard has been useful to you and you feel like contributing, consider submitting a bug report, feature request or a pull request.

See our contributing guidelines for more information.

Joining the discussion

If you want to get involved in the community, need help with getting set up, have any issues or just want to discuss IOTA, feel free to join our Discord.