https://github.com/iotaledger/wasp-dashboard
standalone dashboard for Wasp node software
https://github.com/iotaledger/wasp-dashboard
Last synced: 12 months ago
JSON representation
standalone dashboard for Wasp node software
- Host: GitHub
- URL: https://github.com/iotaledger/wasp-dashboard
- Owner: iotaledger
- License: apache-2.0
- Created: 2022-09-19T10:55:07.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-18T12:31:00.000Z (over 2 years ago)
- Last Synced: 2024-05-02T02:02:27.235Z (about 2 years ago)
- Language: TypeScript
- Size: 6.45 MB
- Stars: 4
- Watchers: 22
- Forks: 1
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
IOTA Wasp Dashboard
About ◈
Prerequisites ◈
Getting started ◈
Supporting the project ◈
Joining 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](https://nodejs.org/en/download/) installed on your device.
To check if you have Node.js installed, run the following command:
```bash
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](https://github.com/iotaledger/wasp/tree/develop/tools/local-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](https://github.com/iotaledger/wasp/tree/develop/tools/local-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`
3. Run a dev-server instance by running `npm start` within the repo root directory.
4. 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](https://github.com/iotaledger/wasp-dashboard/issues/new), [feature request](https://github.com/iotaledger/wasp-dashboard/issues/new) or a [pull request](https://github.com/iotaledger/wasp-dashboard/pulls/).
See our [contributing guidelines](.github/CONTRIBUTING.md) 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](https://discord.iota.org/).