TODO: Description

• ZK Dashboard
  • Table of contents
  • Dashboard ./dashboard
    • Getting started
    • Technologies used
    • Deployment
  • Synchronizer ./synchronizer
  • Infra ./infra
  • Common ./common

ZK Dashboard visualize the data from the ZK ecosystem.

To start the project locally, install the dependencies and run the development server.

In the root of the project, install the dependencies:

nvm use # Use the correct node version
npm install

Create a .env file based on the .env.example file and fill in the required values (./dashboard/.env):

cp .env.example .env`

Run the development server (./dashboard):

npm run dev

• NPM Workspaces: Simple monorepo management
• Next.js: React framework (App router)
• NextUi: UI library
• Drizzle ORM: headless TypeScript ORM
• Postgres: Database

The dashboard is deployed to Vercel using the Vercel for GitHub integration.

Script that synchronizes data from different sources to the database

Pulumi project that deploys the infrastructure

Common code used by the different workspaces