|
| 1 | +# Blockchain Explorer |
| 2 | + |
| 3 | +A professional blockchain explorer web application that provides comprehensive insights into blockchain networks, with enhanced data visualization and user interaction capabilities. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Real-time transaction tracking |
| 10 | +- Detailed block information |
| 11 | +- Address history and balance tracking |
| 12 | +- Transaction receipt generation |
| 13 | +- Export data in multiple formats (JSON, CSV) |
| 14 | +- Responsive Material UI-inspired design |
| 15 | +- Real-time data updates via WebSocket |
| 16 | + |
| 17 | +## Screenshot |
| 18 | + |
| 19 | +- Home Page ( [Screenshot](https://raw.githubusercontent.com/Pymmdrza/pyExplorer/refs/heads/main/.github/index_screen.png) ) |
| 20 | +- Transaction Page ( [Screenshot](https://raw.githubusercontent.com/Pymmdrza/pyExplorer/refs/heads/main/.github/transaction_screen.png) ) |
| 21 | +- Address Page ( [Screenshot](https://raw.githubusercontent.com/Pymmdrza/pyExplorer/refs/heads/main/.github/address_screen.png) ) |
| 22 | +- Block Page ( [Screenshot](https://raw.githubusercontent.com/Pymmdrza/pyExplorer/refs/heads/main/.github/block_screen.png) ) |
| 23 | + |
| 24 | +## Quick Start |
| 25 | + |
| 26 | +### Docker |
| 27 | + |
| 28 | +``` |
| 29 | +docker pull pymmdrza/pyexplorer:latest |
| 30 | +docker run -d -p 5000:5000 --name pyexplorer pymmdrza/pyexplorer:latest |
| 31 | +``` |
| 32 | + |
| 33 | +### Local Installation |
| 34 | + |
| 35 | +```bash |
| 36 | +# Install the blockchain explorer |
| 37 | +pip install blockExplorer |
| 38 | + |
| 39 | +# Install required dependencies |
| 40 | +blockExplorer install local |
| 41 | + |
| 42 | +# Run the application |
| 43 | +blockExplorer run local |
| 44 | +``` |
| 45 | + |
| 46 | +The application will be available at `http://localhost:5000` |
| 47 | + |
| 48 | +### Docker Installation |
| 49 | + |
| 50 | +```bash |
| 51 | +# Install the blockchain explorer |
| 52 | +pip install blockExplorer |
| 53 | + |
| 54 | +# Install Docker dependencies and setup |
| 55 | +blockExplorer install docker |
| 56 | + |
| 57 | +# Run using Docker |
| 58 | +blockExplorer run docker |
| 59 | +``` |
| 60 | + |
| 61 | +## Configuration |
| 62 | + |
| 63 | +The application uses a `config.json` file for API endpoints and other settings. You can modify this file to change the blockchain nodes and APIs used by the application. |
| 64 | + |
| 65 | +## Development |
| 66 | + |
| 67 | +To set up the development environment: |
| 68 | + |
| 69 | +```bash |
| 70 | +git clone https://github.com/Pymmdrza/pyExplorer |
| 71 | +cd blockExplorer |
| 72 | +pip install -e . |
| 73 | +``` |
| 74 | + |
| 75 | +## CLI Commands |
| 76 | + |
| 77 | +### Installation |
| 78 | +- `blockExplorer install local`: Install all required dependencies for local deployment |
| 79 | +- `blockExplorer install docker`: Setup Docker environment and install dependencies |
| 80 | + |
| 81 | +### Running |
| 82 | +- `blockExplorer run local`: Run the application locally |
| 83 | +- `blockExplorer run docker`: Run the application using Docker |
| 84 | + |
| 85 | +## License |
| 86 | + |
| 87 | +This project is licensed under the MIT License - see the LICENSE file for details. |
0 commit comments