GitProHub Discovery API

Discovery API

GitHub repositories se gitprohub.md ko discover karke project information ko API ke through access karein. Developers apne projects ko ek simple file ke through GitProHub ecosystem me expose kar sakte hain.

https://gitprohub.onrender.com

How Discovery Works

GitProHub repository ko scan karta hai aur root level par available gitprohub.md file ko project metadata ke source ke roop me use karta hai.

GitHub Repository Public repository available hoti hai.

Repository Scan GitProHub repository ko scan karta hai.

File Detection Root me gitprohub.md detect hota hai.

Project Discovery Project information API me available hoti hai.

GET STARTED

Add Your Project

GitHub repository me sirf gitprohub.md add karein aur GitProHub aapke project ko automatically discover kar sakta hai.

Create the File

Apne GitHub repository ke main/root level par gitprohub.md file banayein.

📄 gitprohub.md

GitProHub Template

# Project-Name

## Project

title: Project Name Yahan
description: Short clear description of the project (1-2 lines).
category: Category Name (jaise Developer Tools, Technology Community, Showcase Platform, Developer Profile, Local Information Platform etc.)
status: Active
image: https://full-image-url-here (optional, project banner/screenshot)

## Links

live: https://your-live-website-url/
demo: https://demo-url-if-any/
documentation: https://docs-url-if-any/

## Discover

tags: tag1, tag2, tag3, tag4, haproven, open-source
featured: true
open_source: true

Put It in Root

gitprohub.md ko repository ke main/root level par rakhein. GitProHub isi location par file ko identify karta hai.

📦 your-repository/
  ├── 📄 gitprohub.md
  ├── 📄 README.md
  └── 📁 src/

✓ Required /gitprohub.md

Why Root? Discovery scan root level par file ko identify karta hai.

Important /src/ ya /docs/ ke andar file na rakhein.

Commit & Push

File repository me add karne ke baad GitHub par commit aur push karein.

git add gitprohub.md

git commit -m "Add GitProHub card"

git push

✓ Repository GitHub par publicly accessible honi chahiye.

Wait for Discovery

GitProHub repositories scan karta hai. Agar root me gitprohub.md milta hai, to project discovery process me aa sakta hai.

GitHub

Repository information fetch hoti hai.

Scan

Repository files check ki jaati hain.

Detect

Root-level gitprohub.md identify hota hai.

Project

Project data GitProHub API me available ho sakta hai.

Check Your Project

Discovery ke baad API endpoints se check karein ki project data available hai ya nahi.

GitHub Account


                                            /api/github/USERNAME

Specific Project


                                            /api/project/USERNAME/REPOSITORY

All Projects


                                            /api/projects

Discovery Status


                                            /api/discovery/status

Open GitProHub API →

Requirements

GitProHub discovery ke liye repository ko ye basic requirements follow karni chahiye.

✓

Public repository
Repository GitHub par publicly accessible honi chahiye.

✓

Root-level file
gitprohub.md repository ke root me honi chahiye.

✓

Exact filename
Filename exactly gitprohub.md hona chahiye.

✓

Project metadata
File me project ki required information available honi chahiye.

API Endpoints

GitProHub project discovery aur project data access karne ke liye available endpoints.

GET Discover GitHub User Projects


                                /api/github/USERNAME

GitHub username ke repositories ko scan karke discoverable GitProHub projects return karta hai.

Example

GET /api/github/codersusheel

Try Endpoint →

GET Get Specific Project


                                /api/project/USERNAME/REPOSITORY

Kisi specific GitHub repository ke GitProHub project data ko retrieve karta hai.

Example

GET /api/project/codersusheel/haprocard

GET Get All Projects


                                /api/projects

GitProHub me currently available discovered projects ka collection return karta hai.

Try Endpoint →

Response

GitHub user discovery endpoint project discovery information ke saath JSON response return kar sakta hai.

Example JSON Response

{
    "success": true,
    "username": "USERNAME",
    "total": 1,
    "projects": [
        {
            "name": "Project Name",
            "description": "Project description",
            "status": "In Development",
            "category": "Developer Tool",
            "author": "Developer Name",
            "organization": "Organization",
            "live": "https://example.com/",
            "github": "https://github.com/USERNAME/REPOSITORY"
        }
    ]
}

Simple Workflow

One file se project discovery tak ka simple workflow.

Create gitprohub.md

Add Repository Root

Push GitHub Repository

Discover GitProHub

Start Building

Apne GitHub repository ke root me gitprohub.md add karein aur GitProHub discovery workflow ka use karein.

Open GitProHub API →