Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 2.12 KB

README.md

File metadata and controls

61 lines (47 loc) · 2.12 KB

DotSight: Advanced Analytics for Web3

DotSight is an advanced analytics data platform developed by FiDi. It empowers users to effortlessly construct high-precision data pipelines and seamlessly visualize on-chain data with minimal or no coding required.

Use DotSight UI to define data widgets and query them without updating the codebase.

Contents

Quick Start

After cloning the DotSight repository and ensuring you have node v18, npm v9, and docker v20, or above:

# install all necessary dependencies
npm ci
# populate and review the environment variables
cp .env.example .env 
# start the environment
docker compose up -d 
# populate the database for the first run
npm run typeorm:run-migrations 
# initiate a development instance (authentication disabled)
npm run start:dev

# initiate a production instance (specify authentication tokens in .env)
npm run start

Testing and Quality Assurance

Please make sure your PRs come with sufficient unit test coverage:

  1. For any new class logic and functions, you're welcome to add corresponding unit tests under .spec.ts.
  2. Validate that the coverage is sufficient via npm run test:cov

License

DotSight is released under the Apache License. Please see the license file for more information regarding the terms and conditions of use.

Contact and Support

For questions, feedback, and support requests, you can us through the following channels:

Acknowledgments

We would like to express our gratitude to the Web3 Foundation, Parity, Subsquid, and DotSama’s collators community, who all have inspired and contributed to this work and our vision of building a best-in-class analytics data platform for Web3.