Skip to main content
Get Repolyze running on your local machine in minutes. This guide walks you through the installation process step by step.

​
Prerequisites

Before you begin, ensure you have the following installed:

Node.js

Version 18.0 or higher required

pnpm

Recommended package manager

Git

For cloning the repository

PostgreSQL

Database for user data and rate limiting

​
Verify Prerequisites

Check that you have the correct versions installed: 
# Check Node.js version (should be >= 18.0.0)
node --version

# Check if pnpm is installed
pnpm --version

# Check Git installation
git --version

# Check PostgreSQL installation
psql --version
If you don’t have pnpm installed, you can install it globally:
npm install -g pnpm

​
Installation Steps

1

Clone the Repository

Clone the Repolyze repository from GitHub:
git clone https://github.com/OssiumOfficial/Repolyze.git
cd Repolyze
Alternatively, if you’re contributing, fork the repository first:
# Clone your fork
git clone https://github.com/YOUR_USERNAME/Repolyze.git
cd Repolyze

# Add upstream remote
git remote add upstream https://github.com/OssiumOfficial/Repolyze.git
2

Install Dependencies

Install all required dependencies using pnpm:
pnpm install
This will install all dependencies listed in package.json, including:
  • Next.js 16.1.0 (React 19.2.3)
  • Prisma (database ORM)
  • NextAuth (authentication)
  • AI SDK packages
  • UI components and styling libraries
The postinstall script will automatically run prisma generate to create the Prisma client.
3

Set Up Environment Variables

Copy the example environment file:
cp .env.example .env.local
Then configure your environment variables. See the Environment Variables page for detailed configuration.
4

Set Up the Database

Initialize your PostgreSQL database with Prisma:
# Generate Prisma client
pnpm prisma generate

# Run database migrations
pnpm prisma migrate dev
See the Database Setup page for detailed database configuration.
5

Start the Development Server

Launch the development server:
pnpm dev
The application will be available at http://localhost:3000
The dev server supports hot module replacement (HMR), so your changes will be reflected immediately.
6

Verify Installation

Open your browser and navigate to http://localhost:3000. You should see the Repolyze homepage.Test the installation by analyzing a public repository:
  1. Enter a GitHub repository URL (e.g., https://github.com/vercel/next.js)
  2. Click “Analyze”
  3. Wait for the analysis to complete
If you see results, your installation is successful!

​
Available Scripts

Once installed, you can use these npm scripts during development: 
# Start development server with hot reload
pnpm dev

​
Tech Stack Overview

Repolyze is built with modern technologies:
CategoryTechnologies
FrameworkNext.js 16, React 19, TypeScript 5
DatabasePostgreSQL with Prisma ORM
AuthenticationNextAuth.js 5 (Beta)
StylingTailwind CSS 4, shadcn/ui
AnimationFramer Motion, GSAP
DiagramsMermaid
PDF ExportjsPDF
AIOpenRouter AI SDK

​
Troubleshooting

If you see errors about Node.js version:
# Install Node 18 or higher using nvm
nvm install 18
nvm use 18
Or download the latest LTS version from nodejs.org
Install pnpm globally:
npm install -g pnpm
Or use npm/yarn instead:
npm install
npm run dev
Regenerate the Prisma client:
pnpm prisma generate
If issues persist, delete the generated client and regenerate:
rm -rf lib/generated/prisma
pnpm prisma generate
Change the port by setting the PORT environment variable:
PORT=3001 pnpm dev
Verify your DATABASE_URL in .env.local is correct and PostgreSQL is running:
# Check if PostgreSQL is running
psql -U postgres -c "SELECT version();"
See the Database Setup page for more details.

​
Next Steps

Environment Variables

Configure API keys and environment settings

Database Setup

Set up PostgreSQL and run migrations

Project Architecture

Understand the codebase organization

Contributing

Learn how to contribute to Repolyze

Build docs developers (and LLMs) love

Get started for freeTalk to us