CodePraise Web API

Web API that allowsGithub projects to be appraised for inidividual contributions by members of a team.

Routes

Root check

GET /

Status:

• 200: API server running (happy)

Appraise a previously stored project

GET /projects/{owner_name}/{project_name}[/{folder}/]

Status

• 200: appraisal returned (happy)
• 404: project or folder not found (sad)
• 500: problems finding or cloning Github project (bad)

Store a project for appraisal

POST /projects/{owner_name}/{project_name}

Status

• 201: project stored (happy)
• 404: project or folder not found on Github (sad)
• 500: problems storing the project (bad)