An open API service indexing awesome lists of open source software.

https://github.com/magickbase/blockscan


https://github.com/magickbase/blockscan

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

BlockScan


this project fork from Blockscout v4.1.5.

## About
BlockScan is a explorer for ETH compatible chain like [Axon](https://github.com/nervosnetwork/axon) Side Chain which is a layer2 network build on [Nervos Network](https://www.nervos.org/) [CKB](https://github.com/nervosnetwork/ckb)
## Getting Started
1. install latest docker and docker compose
2. run pg database on the host machine
3. edit `xxx.env` file
4. build command `docker-compose --env-file ./dev.env -f ./docker-compose.yml build blockscan`
5. run database `docker-compose --env-file ./dev.env -f ./docker-compose.yml up --force-recreate db`
6. run command `docker-compose --env-file ./dev.env -f ./docker-compose.yml up --force-recreate blockscan`
7. use your env file instead of dev.env
## Github Action
1. setting your forked project environment: "axon_staging" (you can change it in your github workflow file)
2. setting secret environment `ENV_FILE_PATH` which directing real path of your .env file on the deployment server
3. pushing to `main` or `develop` branch (you can change it in your github workflow file)
4. [`.env` fields meaning](./docs/envs_means.md)
5. primary enviroment setting:
* ETHEREUM_JSONRPC_HTTP_URL (setting your chain node rpc endpoint)
* ETHEREUM_JSONRPC_TRACE_URL (setting your chain node rpc endpoint)
* DATABASE_URL (setting explorer access database url)

## Acknowledgements
- We would like to thank the [Nervos Network](https://www.nervos.org/) for their funding support.
- And also thanks to [blockscout](https://github.com/blockscout/blockscout) team, this project was forked from blockscout v4.1.5.

## Contributing
just fork and pull request

## License
[![License: GPL v3.0](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.