https://github.com/autonomys/astral
Home of our Block Explorer
https://github.com/autonomys/astral
autonomys block-explorer typescript
Last synced: 8 months ago
JSON representation
Home of our Block Explorer
- Host: GitHub
- URL: https://github.com/autonomys/astral
- Owner: autonomys
- Created: 2022-10-12T16:29:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T13:53:32.000Z (8 months ago)
- Last Synced: 2025-04-28T13:57:21.251Z (8 months ago)
- Topics: autonomys, block-explorer, typescript
- Language: TypeScript
- Homepage: https://explorer.autonomys.xyz
- Size: 184 MB
- Stars: 14
- Watchers: 6
- Forks: 14
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Astral Block Explorer
- [Astral Block Explorer](https://explorer.autonomys.xyz/) Astral Block Explorer
## Astral Block Explorer
## Overview
- [Explorer](./explorer/README.md) - Next.js app based on React and Tailwind CSS, uses Apollo Client to fetch data from Astral Indexers
- [Indexers](./indexers/README.md) - Includes various SubQuery indexers organized by network and functionality
## 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:**
```bash
git clone https://github.com/autonomys/astral.git
cd astral
```
2. **Move to the explorer directory:**
```bash
cd explorer
```
3. **Install the dependencies:**
```bash
yarn install
```
4. **Copy the environment variables:**
```bash
cp .env.sample .env
```
5. **Run the development server:**
```bash
yarn dev
```
Open [http://localhost:3000](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:**
```bash
cd indexers
```
2. **Install the dependencies:**
```bash
yarn
```
3. **Build the indexers:**
```bash
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:
```bash
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.
```bash
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](LICENSE.md).