Getting StartedInstallation

Installation

This product is a Next.js application. The local setup is intentionally short so a reviewer can clone the repository, run it, and evaluate the analyzer quickly.

Prerequisites

  • Node.js 18 or newer
  • npm
  • Optional: a GitHub personal access token for higher rate limits

Install Dependencies

npm install

Configure Environment

Copy the example environment file and add a GitHub token if you expect to analyze more than a handful of repositories per hour.

cp .env.example .env.local

Then edit the file:

GITHUB_TOKEN=ghp_your_token_here
⚠️

The token is optional for development, but without it the GitHub API budget is typically limited to about 60 requests per hour.

Start The App

npm run dev

Open http://localhost:3000. The root page redirects to the analyzer experience.

Why The Token Matters

Each repository analysis needs approximately five to six GitHub API calls, depending on whether dependency inspection requires fetching package.json. That means:

  • Without GITHUB_TOKEN: roughly 10 repositories per hour
  • With GITHUB_TOKEN: roughly 830 repositories per hour

What Gets Installed

The current stack is centered around:

  • Next.js 16 with the App Router
  • Tailwind CSS v4
  • Octokit v5 for GitHub API access
  • Zod v4 and React Hook Form for validation

Next Steps

Task 2: Analyzer ToolQuick Start