Ark Explorer 3.0
Designed and developed from the ground-up, using lean & fast developmental frameworks (Tailwind CSS & Vue.JS).
Lead Maintainer: Michel Kraaijeveld
You can access it at https://explorer.ark.io/.
Build Setup
1. Clone the repository
git clone https://github.com/ArkEcosystem/explorer
2. Install Dependencies
yarn install
3. Build for Production
3.1 Mainnet
yarn build:mainnet
3.2 Devnet
yarn build:devnet
3.3 Custom
yarn build --network my-custom-network
3.4 GitHub Pages
If you are going to host your explorer instance on GitHub Pages you will need to specify your base url in most cases as GitHub Pages serves repositories from sub-directories instead of sub-domains.
yarn build --base https://username.github.io/repository/
A running instance of the explorer on GitHub Pages can be found at https://arkecosystem.github.io/.
This step is not required if you are hosting the explorer on your "root" repository which is usually your username https://username.github.io/.
3.5 Run Express Server
You can run the explorer as an express server. This makes it a little more light-weight but not needing to have services such as apache or nginx.
EXPLORER_HOST="127.0.0.1" EXPLORER_PORT="4200" node express-server.js
Keep in mind that this requires you to run your own server and a running instance of nginx.
4. Development
4.1 Mainnet
yarn serve # or yarn serve:mainnet
4.2 Devnet
yarn serve:devnet
4.3 Custom
yarn serve --env.network=custom
5. History Mode
If you wish to remove the /#/
from your URLs you can follow those steps https://router.vuejs.org/en/essentials/history-mode.html.
5.1 Build
yarn build:mainnet --history
5.2 Development
yarn serve --env.routerMode=history
Testing
$ yarn test
Contributing
- If you find any bugs, submit an issue or open a pull-request, helping us catch and fix them.
- Engage with other users and developers on the ArkEcosystem Slack.
- Join our gitter.
- Contribute bounties.
Security
If you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.
Credits
This project exists thanks to all the people who contribute.