@moosty/lisk-explorer
v0.1.3-alpha.1
Published
Lisk agnostic explorer connect to lisk-service and start exploring your blockchain
Downloads
8
Readme
Lisk Explorer
This explorer is an abstraction from Liskscan.
When running this Lisk explorer you can browse the connected blockchain.
Lisk-explorer is built with NextJS and connects directly to the lisk-service
gateway.
Usage
Dependencies
For the explorer to run you need at least node v12
| Dependencies | Versions | Tested on versions | | ------------ |----------|--------------------| | NodeJS | 12+ | 12, 14, 16 | | Lisk Service | 0.6.0. | 0.6.0 |
Lisk Service
Lisk explorer uses Lisk service as it's data source. For more information about installing Lisk service look here.
Clone
git clone https://github.com/liskscan/lisk-explorer.git
cd lisk-explorer
Configure the explorer
Edit the .env
file variables to configure your explorer.
The NEXT_PUBLIC_NETWORK_WS
and NEXT_PUBLIC_NETWORK_HTTP
should point to your Lisk service gateway and needs to be reachable through the browser
NEXT_PUBLIC_NETWORK_WS=wss://public-service-gateway-host.com
NEXT_PUBLIC_NETWORK_HTTP=https://public-service-gateway-host.com
The NEXT_PUBLIC_LOCAL_NETWORK_WS
and NEXT_PUBLIC_LOCAL_NETWORK_HTTP
should point to your Lisk service gateway and need to be reachable at the machine this explorer runs on.
Preferably use service on the same machine this explorer runs on for better performance
NEXT_PUBLIC_LOCAL_NETWORK_WS=ws://localhost:9292
NEXT_PUBLIC_LOCAL_NETWORK_HTTP=http://localhost:9292
Install NodeJS dependencies and build Lisk Explorer
npm run init
Build explorer
npm run build
Start explorer
npm run start
After updating the .env
always run npm run build
first
Start pm2
pm2 start pm2.conf.json
Run dev mode
npm run dev
Configure
- Edit configuration in .env
- Change the theme colors in styles/theme.css
- Don't forget to run
npm run build
after any changes
License
Copyright 2022 Moosty
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.