Astral Block Explorer

• Astral Block Explorer Astral Block Explorer
• Health Check Subspace Network Status Page

Astral Block Explorer

Subspace Network Status Page

Overview

• Explorer - Next.js app based on React and Tailwind CSS, uses Apollo Client to fetch data from Astral Indexers
• Indexers - Includes various SubQuery indexers organized by network and functionality
• Health check - utility service to check health status of an internal service and expose it as a REST API endpoint

Development

Prerequisites

Ensure you have the following installed on your local development machine:

• Node.js (v18.x or later)
• Yarn (v2.x or later)

You can check your Node and Yarn versions with 'node -v' and 'yarn -v' respectively.

Installation

These step focus on setting up the development environment for the Astral Block Explorer. You can also find the instructions for setting up the Squid backend and Health check services in their respective directories.

1. Clone the repository:

   git clone https://github.com/autonomys/astral.git
   cd astral

2. Move to the explorer directory:

   cd explorer

3. Install the dependencies:

   yarn install

4. Run the development server:

   yarn dev

   Open http://localhost:3000 with your browser to see the result.

Multi-Network Indexers Setup

To set up the multi-network indexers, follow these steps:

1. Navigate to the indexers directory:

   cd indexers

2. Install the dependencies:

   yarn

3. Build the indexers:

   yarn codegen && yarn build

4. Start a local node, the PostgreSQL database with multiple tables, Hasura, and various SubQuery nodes and a TaskBoard (BullMQ) using Docker Compose:

   From the root directory, run:

   yarn dev

This command will initialize a PostgreSQL database configured with multiple tables, launch the Hasura GraphQL engine, and start multiple Subquery nodes to index all networks. This setup provides all the necessary data for different sections of the explorer, ensuring a comprehensive indexing solution for the application.

Contributing

We welcome contributions to this project. If you are interested in enhancing the features of the app or fixing bugs, please follow these steps:

1. Fork the Repository

   Fork the project to your own GitHub account. This will be your private workspace for staging changes.

2. Create a Branch

   Create a branch in your forked repository for each set of changes you intend to make or issue you are addressing.

   git checkout -b your-branch-name

3. Discuss New Features

   For new features, it's preferable to first open an issue to discuss potential changes. This helps ensure that your efforts align with the project direction and that duplicate work is avoided.

4. Bug Fixes

   For bug fixes, feel free to create a branch and proceed with fixes. Please ensure to clearly describe the bug and how your code resolves it.

5. Make Your Changes

   Make the necessary modifications to the codebase and commit them. Please keep your commits granular and well-explained.

6. Write Tests

   Ensure that your code is tested to prevent regressions.

7. Pull Request

   Submit a pull request to the main branch of the original repository. Provide a clear description of the problem and solution. Include relevant issue numbers if applicable.

8. Code Review

   Your changes will be reviewed by maintainers, who may provide feedback or questions. Address feedback and push your fixes as additional commits.

License

This project is licensed under the MIT License.