{"id":16925947,"url":"https://github.com/davwheat/flarum-badge-api","last_synced_at":"2025-04-05T14:10:35.079Z","repository":{"id":42678958,"uuid":"351227069","full_name":"davwheat/flarum-badge-api","owner":"davwheat","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-22T13:02:45.000Z","size":2233,"stargazers_count":2,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-11T09:56:43.609Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/davwheat.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},"funding":{"github":["davwheat"]}},"created_at":"2021-03-24T21:24:59.000Z","updated_at":"2022-03-28T20:16:44.000Z","dependencies_parsed_at":"2024-10-13T20:12:05.476Z","dependency_job_id":"aba49bf6-b560-4728-87bc-872c866898b7","html_url":"https://github.com/davwheat/flarum-badge-api","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/davwheat%2Fflarum-badge-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davwheat%2Fflarum-badge-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davwheat%2Fflarum-badge-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davwheat%2Fflarum-badge-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davwheat","download_url":"https://codeload.github.com/davwheat/flarum-badge-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247345856,"owners_count":20924102,"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-10-13T20:12:00.098Z","updated_at":"2025-04-05T14:10:35.062Z","avatar_url":"https://github.com/davwheat.png","language":"TypeScript","funding_links":["https://github.com/sponsors/davwheat"],"categories":[],"sub_categories":[],"readme":"# Flarum Badge API\n\nThis is a super simple API that can create badges for your Flarum extensions READMEs.\n\nThis is hosted on my home internet on a Raspberry Pi, so 100% uptime is not guaranteed (though it should come pretty close!).\n\n## Suggestions\n\nIf you want to suggest a new badge, open an issue and explain *clearly* what the badge could contain/show.\n\n## Using the badges\n\nThe documentation in this README is not exhaustive. Please read the documentation found below for all possible badges, options, and information.\n\n[Read the full documentation](https://flarum-badge-api.davwheat.dev/v1)\n\n### Compatible with latest Flarum\n\nThis badge shows whether your extension is compatible with the latest version of Flarum.\n\nMake a call to `https://flarum-badge-api.davwheat.dev/v1/compat-latest/\u003cvendor/package\u003e` (replacing `\u003cvendor/package\u003e` with your extension's package name).\n\nExample badge for `FoF/Formatting`:\n\n![](https://flarum-badge-api.davwheat.dev/v1/compat-latest/fof/formatting)\n\n## Installing and running\n\nNormal people don't need to do this. This is for development purposes only.\n\n1. Create a `.env` file:\n\n```\n# .env\nEXTIVERSE_TOKEN=\u003cyour Extiverse API token\u003e\nBASE_URL=\u003cURL to the API root (no trailing slash\u003e\nPORT=\u003coptional port to run on; defaults to 3000\u003e\n```\n\n\u003c!-- This is not a typo. It's a joke. --\u003e\n2. Install deps \u0026\u0026 start the Express server:\n\n```sh\nyarn\n\n# In one terminal...\nyarn dev\n\n# In another terminal...\nyarn start\n```\n\n### Running permanently on a server\n\n```sh\nnpm i -g pm2\nyarn build\nyarn pm2:watch\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavwheat%2Fflarum-badge-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavwheat%2Fflarum-badge-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavwheat%2Fflarum-badge-api/lists"}