{"id":18870362,"url":"https://github.com/breejs/api","last_synced_at":"2025-04-14T15:21:37.701Z","repository":{"id":38216269,"uuid":"398401394","full_name":"breejs/api","owner":"breejs","description":"An API for Bree.","archived":false,"fork":false,"pushed_at":"2025-03-28T04:30:41.000Z","size":5458,"stargazers_count":13,"open_issues_count":21,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T15:21:30.077Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/breejs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"niftylettuce","patreon":"niftylettuce"}},"created_at":"2021-08-20T21:12:20.000Z","updated_at":"2024-08-10T18:45:27.000Z","dependencies_parsed_at":"2023-02-08T09:01:00.385Z","dependency_job_id":null,"html_url":"https://github.com/breejs/api","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breejs%2Fapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breejs%2Fapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breejs%2Fapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breejs%2Fapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/breejs","download_url":"https://codeload.github.com/breejs/api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248904626,"owners_count":21180836,"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-11-08T05:19:51.908Z","updated_at":"2025-04-14T15:21:37.673Z","avatar_url":"https://github.com/breejs.png","language":"JavaScript","funding_links":["https://github.com/sponsors/niftylettuce","https://patreon.com/niftylettuce"],"categories":[],"sub_categories":[],"readme":"# @breejs/api\n\n[![build status](https://github.com/breejs/ts-worker/actions/workflows/ci.yml/badge.svg)](https://github.com/breejs/ts-worker/actions/workflows/ci.yml)\n[![code coverage](https://img.shields.io/codecov/c/github/breejs/api.svg)](https://codecov.io/gh/breejs/api)\n[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\n[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![made with lad](https://img.shields.io/badge/made_with-lad-95CC28.svg)](https://lad.js.org)\n\n\u003e An API for [Bree][].\n\n## Table of Contents\n\n\n## Install\n\n[npm][]:\n\n```sh\nnpm install @breejs/api\n```\n\n[yarn][]:\n\n```sh\nyarn add @breejs/api\n```\n\n## Usage\n\nExtend bree with the plugin:\n\n```js\nBree.extend(require('@breejs/api').plugin);\n\nconst bree = new Bree(config);\n```\n\nThe API will start automatically when the Bree constructor is called.\n\n## Options\n\n| Option   | Type     | Description                                                                                    |\n| :------: | :------: | ---------------------------------------------------------------------------------------------- |\n| port     | Number   | The port the API will listen on. Default: `62893`                                              |\n| jwt      | Object   | Configurations for JWT. Only option is `secret` which will be the secret used to verify JWT.   |\n| sse      | Object   | Configurations for SSE. See [koa-sse][] for list of options.                                   |\n\n## API\n\nCheck out the [API Docs](https://documenter.getpostman.com/view/17142435/TzzDLbNG).\n\n## Contributors\n\n\n## License\n\n[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)\n\n##\n\n[npm]: https://www.npmjs.com/\n\n[yarn]: https://yarnpkg.com/\n\n[Bree]: https://jobscheduler.net/#/\n\n[koa-sse]: https://github.com/yklykl530/koa-sse\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreejs%2Fapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbreejs%2Fapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreejs%2Fapi/lists"}