Getting Started

Installation

Clone the project and install dependencies:

git clone https://github.com/your-org/maxscan
cd maxscan
npm install

System Requirements

  • Node.js 18+

  • Solana RPC endpoint

  • PostgreSQL or Redis for persistence

  • Docker (optional but recommended)

Environment Setup

Create a .env file with:

  • RPC_URL

  • DATABASE_URL

  • WEBHOOK_URL

  • Optional: logging level, poll interval

Running MaxScan (Local / Docker)

Local:

npm run start

Docker:

docker compose up --build
PreviousIntroductionNextConfiguration

Last updated