Welcome to the world of Subscan Essentials, a powerful blockchain explorer scaffold project aimed at supporting substrate-based blockchain networks. This article will walk you through the essential steps to set it up, troubleshoot common issues, and help you get started with developing your own unique applications.
Features of Subscan Essentials
- Support for Substrate network custom type registration
- Indexing capabilities for Block, Extrinsic, Event, and Logs
- Custom plugins for extended indexing
- Automatic plugin template generation with the Gen tool
- Built-in default HTTP API documentation
Quick Start
Let’s dive right into the setup process! Below are the prerequisites, installation instructions, and basic configurations necessary to get you started.
Requirements
- Linux or Mac OSX
- Git
- Golang 1.12.4+
- Redis 3.0.4+
- MySQL 5.6+
- Node 8.9.0+
Installation Steps
- Run the build script:
bash build.sh
cd ui && yarn && yarn dev
User Interface (UI)
The UI of Subscan Essentials is built with nuxt.js and amis. To customize it, update your nuxt.config.js
file to change the proxy target to your server:
proxy: {
api: {
target: 'https://your_server_name.com',
secure: false,
changeOrigin: true,
pathRewrite: {'^api': 'api'}
}
}
Configuration
After the installation, initiate the config file with:
bash cp configs/config.yaml.example configs/config.yaml
Then, configure Redis, MySQL, and HTTP server details based on your requirements.
Usage Instructions
Make sure to start your Redis and MySQL services before proceeding. To run the Subscan service, use the following commands:
bash
cd cmd/subscan
bash subscan start substrate
Using Docker for Quick Setup
If Docker is your preferred method, use docker-compose to quickly start projects:
docker network create app_net
docker-compose -f docker-compose.db.yml up -d
docker-compose build
docker-compose up -d
Troubleshooting Common Issues
While following the steps above, you may encounter some common issues. Here are troubleshooting tips to help you:
- Redis or MySQL not starting? Ensure that they are installed and correctly configured.
- UI won’t load? Check that the development server is running and verify your
nuxt.config.js
settings. - Database connection errors? Double-check your MySQL credentials and the database name specified in the configuration.
For additional support or to connect with a community of developers, feel free to visit and collaborate on projects via fxis.ai.
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.
Conclusion
Subscan Essentials offers a robust foundation for anyone looking to build blockchain explorer applications. By following the setup instructions and utilizing the features available, you can extend functionalities and create unique user experiences.
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.