Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/migalabs/eth-seer
This dashboard summarises all the collectable metrics from the ethereum network in an awesome looking webapp
https://github.com/migalabs/eth-seer
Last synced: about 8 hours ago
JSON representation
This dashboard summarises all the collectable metrics from the ethereum network in an awesome looking webapp
- Host: GitHub
- URL: https://github.com/migalabs/eth-seer
- Owner: migalabs
- Created: 2022-11-29T13:24:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T18:40:49.000Z (4 months ago)
- Last Synced: 2024-08-01T20:55:11.978Z (4 months ago)
- Language: TypeScript
- Size: 122 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
Ethseer.io provides information about the Beacon Chain of Ethereum. It displays the blocks being produced in real-time with a user-friendly interface and allows users to search for information in an engaging manner to understand the Blockchain.
## :ledger: Table of contents
- [Usage](#zap-usage)
- [Pre-Requisites](#abc-pre-requisites)
- [Installation](#electric_plug-installation)
- [Commands](#package-commands)
- [Community](#cherry_blossom-community)
- [Contribution](#hand-contribution)
- [Branches](#cactus-branches)
- [Maintainers](#people_hugging-maintainers)
- [Supported Networks](#spider_web-supported-networks)
- [Gallery](#camera-gallery)
- [Acknowledgement](#stars-creditacknowledgment)
- [Contact](#mailbox-contact)
- [License](#lock-license)
## :zap: Usage
### :abc: Pre-requisites
Before you continue, ensure you have met the following requirements:
- [Node.js](https://nodejs.org/): Make sure you have Node.js installed on your machine. You can download and install it from [here](https://nodejs.org/).
- [Docker Engine](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/): Ensure Docker Engine and Docker Compose are installed on your machine. You can download and install them from the provided links.
These prerequisites are necessary for running and building the project. Make sure to have them installed before proceeding.
### :electric_plug: Installation
1. Clone the repository:
```jsx
$ git clone https://github.com/migalabs/eth-seer.git
```
Or if you have SSH key:
```jsx
$ git clone [email protected]:migalabs/eth-seer.git
```
2. Create .env file within the `packages/client` and `packages/server` directories. There are examples in both directories of these files. (`packages/client/.env.example` and `packages/server/.env.example`).
### :package: Commands
- To install dependencies:
```jsx
$ npm run ci
```
- To run the client:
```jsx
$ npm run app
```
- To run the server:
```jsx
$ cd packages/server
$ npm run build
$ npm run start
```
- Connect to database
An example database connection is:
```
NETWORKS='[
{ "network": "mainnet", "user": "ethseer-reader", "host": , "name": "ethseer-mainnet", "port": 5432, "password": "pass" },
{ "network": "goerli", "user": "ethseer-reader", "host": , "name": "ethseer-goerli", "port": 5432, "password": "pass" },
]'
```
### :pencil: Execution
`docker-compose up -d`
All systems should boot and start working as normal.
### :package: Bundle Setup
Ethseer's data is powered by [GotEth](https://github.com/migalabs/goteth). Thus, please refer [to this repository](https://github.com/migalabs/eth-coffee), which contains all the needed configurations to easily run GotEth with Ethseer.
## :cherry_blossom: Community
### :hand: Contribution
Contributions are always welcome and appreciated. If you’d like to contribute to Ethseer, there are several ways you can help:
1. **Report a bug**
If you encounter any bugs or have suggestions for improvements, feel free to open an issue [here](https://github.com/migalabs/eth-seer/issues) and we will take care of it.
2. **Request a feature**
If you have ideas for new features, feel free to open an issue [here](https://github.com/migalabs/eth-seer/issues) to discuss and propose your ideas.
3. **Create a pull request**
If you'd like to contribute directly by implementing new features or fixing bugs, please fork the repository, create a new branch, and submit a pull request [here](https://github.com/migalabs/eth-seer/pulls).
Before submitting a pull request, make sure to:
- Follow the coding style and conventions used in the project.
- Write tests for any new functionality or changes.
- Update the documentation if needed.
> If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
### :cactus: Branches
1. **`dev`** is the development branch.
2. **`main`** is the production branch.
3. No other permanent branches should be created in the main repository, you can create feature branches but they should get merged with the master.
**Steps to work with feature branch**
1. To start working on a new feature, create a new branch prefixed with `feat` and followed by feature name. (ie. `feat-FEATURE-NAME`)
2. Once you are done with your changes, you can raise PR.
**Steps to create a pull request**
1. Make a PR to `dev` branch.
2. Comply with the best practices and guidelines e.g. where the PR concerns visual elements it should have an image showing the effect.
3. It must pass all checks and get positive reviews.
After this, changes will be merged.
## :people_hugging: Maintainers
Thanks go to these wonderful people:
Leonardo Bautista-Gomez
Tarun Mohandas Daryanani
Mikel Cortes-Goicochea
Santiago Somoza
Josep Chetrit
Iuri Pons
Marina Terentii Cebotari
Marc Pujadas
## :spider_web: Supported Networks
Ethseer is compatible with the following Blockchain networks:
- **Mainnet:** The primary Ethereum network used for transactions and contracts in the production environment.
- **Goerli:** A test network for Ethereum, used for development and testing. Goerli will be deprecated soon.
- **Sepolia:** A test network for Ethereum designed specifically for developers to test and experiment with their smart contracts and DApps before deploying them on the mainnet.
- **Holesky:** A test network for Ethereum, the purpose is to closely replicate real conditions on the Ethereum network.
- **Devnet9:** A devnet network for Ethereum Devnet-cancun ([EIP4844](https://www.eip4844.com/)) upgrade.
When using Ethseer, make sure to configure the appropriate network based on your needs, whether it's for operations on the main network (Mainnet) or for testing in a development environment.
## :camera: Gallery
Enjoy the experience here:
## :stars: Credit/Acknowledgment
This project was done by our Migalabs team. Feel free to check our website and other services we offer [here](https://migalabs.io/).
## :mailbox: Contact
If you have any questions related to our platform, projects or services, please don't hesitate to contact us here.
- **Say hello :wave:** :
- Twitter
- Discord
## :lock: License
Ethseer is licensed under the [BSD-3-Clause](https://opensource.org/license/bsd-3-clause/) License.
**[⬆ back to top](#ledger-table-of-contents)**