Get Starter

GET /api/starters/:id

Returns detailed information about a specific starter template, including its metadata, technologies, features, and quality metrics.

Path Parameters

id

The unique identifier of the starter template. This is typically the repository name or a unique slug.

Example: /api/starters/create-t3-app

Response

Success Response

{
  "metadata": {
    "name": "starter-name",
    "url": "https://github.com/user/repo"
  },
  "technologies": [
    "react",
    "typescript",
    "tailwind"
  ],
  "features": {
    "development": {
      "testing": true,
      "linting": true
    },
    "security": {
      "authentication": true
    }
  },
  "quality": {
    "maintenance": {
      "commitFrequency": 4,
      "issueResponseTime": 5
    },
    "documentation": {
      "readmeCompleteness": 4,
      "setupInstructions": 5,
      "exampleCoverage": 4
    }
  },
  "quality_score": 4.4
}

Error Responses

Not Found

{
  "error": {
    "status": 404,
    "message": "Starter not found"
  }
}

Server Error

{
  "error": {
    "status": 500,
    "message": "An error occurred while processing your request"
  }
}

Example Request

curl http://localhost:3000/api/starters/create-t3-app

Response Fields

quality_score

A calculated score between 1-5 that represents the overall quality of the starter template. This is derived from various quality metrics including maintenance and documentation scores.

quality.maintenance

Metrics related to repository maintenance:

commitFrequency: Score based on how frequently the repository is updated
issueResponseTime: Score based on how quickly issues are addressed

quality.documentation

Metrics related to project documentation:

readmeCompleteness: Score based on README.md completeness
setupInstructions: Score based on setup/installation documentation
exampleCoverage: Score based on example code and usage documentation