PRFlow

🚀 PRFlow – Open-Source Contribution Navigator & Developer Platform

PRFlow is a production-grade full-stack platform built to solve developer anxiety and decision fatigue when making their first open-source contributions. It combines automated GitHub issue discovery, an algorithmic beginner-scoring engine, step-by-step Git guides, dual authentication (JWT & GitHub OAuth 2.0), and a personalized Contributor Dashboard backed by MongoDB.


🌐 Live Demo & Preview


✨ Key Features

🔍 Algorithmic Issue Discovery

📊 Contributor Dashboard & Progress Tracker

🔐 Dual Authentication & Security

🧭 Interactive Git & PR Guide


🛠 Tech Stack

Frontend

Backend


🏛 System Architecture

graph TD
    Client["React 19 Frontend (Vite + Tailwind)"]
    AuthCtx["Global AuthContext"]
    GitHubAPI["GitHub REST API"]
    ExpressServer["Express.js Server (Node.js)"]
    PassportOAuth["GitHub OAuth (Passport.js)"]
    MongoDB["MongoDB Atlas (Users & Progress)"]

    Client -->|REST Requests| ExpressServer
    Client -->|Direct Search & Deduplication| GitHubAPI
    Client -->|State Sync| AuthCtx
    ExpressServer -->|OAuth Handshake| PassportOAuth
    ExpressServer -->|Mongoose Queries| MongoDB

📡 API Endpoints

Authentication (/api/auth)

| Method | Endpoint | Description | Protected | |—|—|—|—| | POST | /api/auth/signup | Register new user with hashed password | No | | POST | /api/auth/login | Authenticate user & return JWT token | No | | GET | /api/auth/profile | Retrieve authenticated user profile | Yes (JWT) | | GET | /api/auth/github | Trigger GitHub OAuth authentication flow | No | | GET | /api/auth/github/callback | OAuth redirect callback & token exchange | No |

Contributor Progress (/api/progress)

| Method | Endpoint | Description | Protected | |—|—|—|—| | GET | /api/progress | Fetch all tracked contributions for user | Yes (JWT) | | POST | /api/progress | Start tracking a new GitHub issue | Yes (JWT) | | PUT | /api/progress/:id | Update status (Started ↔ Completed) | Yes (JWT) | | DELETE | /api/progress/:id | Remove a tracked contribution | Yes (JWT) |


🚀 Getting Started Locally

1. Clone the repository

git clone https://github.com/imabhirajj/PRFlow.git
cd PRFlow

2. Backend Setup

cd backend
npm install

Create a .env file in the backend/ directory:

PORT=5000
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret_key
GITHUB_CLIENT_ID=your_github_oauth_client_id
GITHUB_CLIENT_SECRET=your_github_oauth_client_secret
GITHUB_CALLBACK_URL=http://localhost:5000/api/auth/github/callback
CLIENT_URL=http://localhost:5173

Run backend server:

npm run dev

3. Frontend Setup

cd ../frontend
npm install

Create a .env file in the frontend/ directory:

VITE_API_URL=http://localhost:5000

Run development server:

npm run dev

🌐 Production Deployment Configuration

1. Render (Backend) Environment Variables

Configure these in Render Dashboard -> Environment: | Variable | Production Value | Description | |—|—|—| | PORT | 5000 | Port for Express service | | NODE_ENV | production | Production environment flag | | MONGO_URI | mongodb+srv://... | MongoDB Atlas connection string | | JWT_SECRET | <your-jwt-secret> | Secret key for JWT token signing | | CLIENT_URL | https://prflow.vercel.app | Frontend production URL | | GITHUB_CLIENT_ID | <your-github-client-id> | GitHub OAuth App Client ID | | GITHUB_CLIENT_SECRET | <your-github-client-secret> | GitHub OAuth App Client Secret | | GITHUB_CALLBACK_URL | https://prflow-backend.onrender.com/api/auth/github/callback | OAuth callback on Render |

2. Vercel (Frontend) Environment Variables

Configure these in Vercel Dashboard -> Settings -> Environment Variables: | Variable | Production Value | Description | |—|—|—| | VITE_API_URL | https://prflow-backend.onrender.com | Production backend API base URL |

3. GitHub Developer Settings (OAuth App)

Navigate to GitHub -> Settings -> Developer Settings -> OAuth Apps:


👨‍💻 Author

Abhiraj