æScan is a blockchain explorer, analytics platform, and decentralized smart contract navigation platform based on æternity.
- Introduction
- Getting started
- Deployment stages
- Browser compatibility
- Contribution
- Stay in touch
- Resources
With æScan you can easily navigate between different features and live statistics of æternity blockchain: keyblocks, microblocks, accounts, transactions, smart contracts, names and tokens.
Blockchain data is retrieved from æternity middleware and æternity node.
Nuxt 3, Vue.js, Vite and Pinia provide the foundation for the project, enabling us to create a seamless and intuitive user experience with Server Side Rendering enabled.
First, download and install Node.js. Version 20 or higher is required.
Clone æScan repository
git clone https://github.com/aeternity/aescan.git
Install required dependencies with yarn
yarn install
Copy content of .env.example file to .env
Run æScan in development mode with hot reload
yarn dev
A local instance of æScan will be available at http://localhost:8080.
Build and minify for production
yarn build
Lint js and css files
yarn lint
Docker is used to run æScan in different deployment stages.
To build a docker image of æScan Docker is required.
yarn install
docker build -t aescan .
docker run -p 80:80 aescan
Three different deployment stages are available to test or use æScan:
| Stage name | URL | Description |
|---|---|---|
| Production | https://aescan.io | Production environment deployed manually from the main branch by creating a release branch and merging an automatically created Release Pull Request. |
| Development | https://aescan.dev.service.aepps.com | Development environment deployed automatically after every push to the develop branch. |
| PR preview | https://pr-[PR-id]-aescan.stg.service.aepps.com | Pull Request preview deployed automatically after every commit to an open pull request. |
Supports evergreen browsers only.
The core browser set targets the 2 most recent major versions of Chrome, Firefox, and Edge on a monthly basis and Safari on a yearly basis.
This project uses Cypress for e2e testing. Tests can be executed using the
command yarn e2e:open.
We welcome contributions to our repository! If you have an idea for a new feature or a fix for a bug, please feel free to open an issue and/or a pull request. We encourage you to read the full Contribution Guidelines to learn more about the project structure, good practices and rules to follow.
Join æternity forum and participate in discussions. Share your ideas, ask questions, and get involved!
Stay up-to-date on the latest developments in the æternity ecosystem by following us on social media.
Want to learn more about æternity and how it's revolutionizing the world of blockchain technology? Check out our website, Github repositories and blog for more information.