Installation

Installation Guide

Quick Start

Get up and running with GitHub Profile Card in minutes.

Prerequisites

• Node.js (v18 or higher)
• npm or pnpm package manager
• Git

Installation Steps

1. Clone the Repository

git clone https://github.com/nayandas69/github-profile-card.git
cd github-profile-card

2. Install Dependencies

Using pnpm:

pnpm install

Or using npm:

npm install

3. Build the Project

pnpm build

4. Start the Development Server

pnpm dev

The application will be available at http://localhost:3000

Deployment

Deploy to Vercel (Recommended)

1. Push your repository to GitHub
2. Go to Vercel
3. Click "Import Project"
4. Select your GitHub repository
5. Click "Deploy"

Manual Deployment

pnpm build
pnpm start

Environment Variables

Create a .env file in the root directory:

GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
UPSTASH_REDIS_REST_URL=https://xxxxxxxx.upstash.io
UPSTASH_REDIS_REST_TOKEN=AxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxE

Troubleshooting

Port Already in Use

pnpm dev --port 3001

Dependencies Installation Issues

pnpm install --force

Clear Cache

pnpm store prune
rm -rf node_modules pnpm-lock.yaml
pnpm install

Next Steps

• Check out the Usage Guide
• Explore API Reference
• View all 56 Available Themes