{"id":22463785,"url":"https://github.com/crowphp/badger-server","last_synced_at":"2025-03-27T14:28:41.045Z","repository":{"id":82533971,"uuid":"328373095","full_name":"crowphp/badger-server","owner":"crowphp","description":"Badger Server to provide rest api for badger cli and coverage report for crowphp","archived":false,"fork":false,"pushed_at":"2021-01-10T20:12:44.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T18:43:05.032Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crowphp.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-10T12:02:55.000Z","updated_at":"2021-01-10T20:12:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"13b3e44f-f9ef-4ca4-b6c0-b23687f48db2","html_url":"https://github.com/crowphp/badger-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowphp%2Fbadger-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowphp%2Fbadger-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowphp%2Fbadger-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowphp%2Fbadger-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crowphp","download_url":"https://codeload.github.com/crowphp/badger-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245862315,"owners_count":20684665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-06T09:14:05.876Z","updated_at":"2025-03-27T14:28:41.037Z","avatar_url":"https://github.com/crowphp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Badger Server\n\nA small server that provides REST API for the badger utility, this lets you save the coverage report in JSON format\nwhich can be than available to use with shields.io.\n\nBadger CLI can update the coverage report in the format for sheilds.io to a given badger server.\n\n## Running you server with docker\n\nUse our official docker image to spin a new badger service\n\n```bash\nsudo docker run --name=badger --privileged --env SECRET_KEY=${provide-secret-key} -d --restart=unless-stopped -p 80:80 crowphp/badger-server:1.4\n``` \n\n## Endpoints\n\n`Creating/Updating`  new coverage report for a branch\n```bash\ncurl --location --request POST 'http://localhost:5005/coverage/{branch}' \\\n--header 'secret-key: Your-secret-here' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n  \"schemaVersion\": 1,\n  \"label\": \"coverage\",\n  \"message\": \"80%\",\n  \"color\": \"yellow\"\n}'\n``` \n\nNotice the schema we are using the shields.io compatible json.\n\n`Retrieving`  the public coverage report for the `branch`\n\n```\ncurl --location --request GET 'http://localhost:5005/coverage/{branch}'\n```\n\nThat's It!\nHappy Coding.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowphp%2Fbadger-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowphp%2Fbadger-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowphp%2Fbadger-server/lists"}