Tokenguard was founded to help web3 projects grow and build utility around their products. We know how to build successful dApps & ecosystems solving real problems with blockchain technology and we want to allow the whole industry to follow this path.
Welcome to the dApp Marvels repository! This repository consists of handy setup scripts to help you get started with dApp Marvels - an on-chain analytics tool designed for Ink! dApps builders to support their growth and operations through in-depth metrics and analytics of on-chain user behavior.
dApp Marvels will help to Polkadot builders create their dApps & protocols faster and easily analyze data coming from their smart contracts without additional hassle.
This guide covers how to set up and run the project for Substrate-bases chains. This respository is umbrella part of a bigger system consisting of 3 components + corresponding databases.
- dashboard-creator-server - the backend service storing information about built dashboards and queries
- dashboard-creator-client - frontend app
- db-api - REST interface between PostgreSQL database and backend service.
- subsquid-indexer - custom squid indexer suited for decoded ABIs for dApps
To fully function backend service needs mongodb to store dashboard configuration, layout and displayed dashboard elements and PostgreSQL database to store indexing data pulled by subsquid indexer.
Before you begin, make sure you have the following installed on your system:
- dApp decoding: with user-provided contract ABIs this app is able to index decoded interactions with the dApp
- dApp indexing: automated deployments of subsquid indexers
- API Reading Mechanism: Connect frontend visualizations with underlying data through a RESTful API built with NodeJS and Express.
- Data Storage: Store visualization and dashboard-related data in MongoDB for efficient retrieval and management.
- Scalability: Built with scalability in mind to handle large datasets and user traffic effectively.
- Metrics Visualisation: Visualize data from raw sources using customizable visualizations such as line charts, bar charts, pie charts, and more.
- Dashboard Layout: Create, save, modify, and delete dashboards with drag-and-drop functionality. Customize dashboard layouts with captions, titles, and links.
- User-Friendly Interface: Intuitive user interface for seamless dashboard creation and customization.
If you just want to start the project to see how it works, just run docker-compose up and it will pull recent images of services and run the app.
For simple and smooth application rollout for further customization and development purposes you can pull all required repositories into fresh directory using a script provided in this repository:
./setup-env.sh
The script pulls repositories in locations expected by docker-compose-dev.yml file enclosed in this repository.
git clone https://github.com/tokenguardio/dashboard-creator-client.git
cd dashboard-creator-client
git checkout dapp-analytics-dev
cd ..
git clone https://github.com/tokenguardio/dashboard-creator-server.git
cd dashboard-creator-server
git checkout dapp-analytics-dev
cd ..
git clone https://github.com/tokenguardio/db-api.git
cd db-api
git checkout dev
cd ..
After the script is done, all you have to do is to let docker-compose run and build/pull all required images.
docker-compose -f docker-compose-dev.yml up
After the environment starts, you should be able to see the frontend app of dApp Marvels at localhost:5173
To clean up environment, simply run
./cleanup.sh
- Backend Framework: NodeJS with Express
- Database: MongoDB, PostgreSQL
- API Documentation: OpenAPI
- Development Tool: Docker
- Frontend Framework: ReactJS, TypeScript, ViteJS
- Data Storage: MongoDB
- Visualization Library: Apache ECharts
We encourage contributions from the community! If you'd like to contribute to the Tokenguard Dashboard Builder Server, please refer to our contribution guidelines for more information.
This project is licensed under the MIT License - see the LICENSE file for details.