{"id":16397416,"url":"https://github.com/foxriver76/iobroker.face-recognition","last_synced_at":"2025-11-14T09:01:50.001Z","repository":{"id":95824662,"uuid":"496135628","full_name":"foxriver76/ioBroker.face-recognition","owner":"foxriver76","description":"Allows to recognize faces from image data","archived":false,"fork":false,"pushed_at":"2022-05-31T07:55:00.000Z","size":37536,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-04T17:46:02.993Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foxriver76.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-05-25T07:57:02.000Z","updated_at":"2022-05-25T13:14:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"b8120da9-b355-4012-ac6b-670578353c5b","html_url":"https://github.com/foxriver76/ioBroker.face-recognition","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/foxriver76%2FioBroker.face-recognition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxriver76%2FioBroker.face-recognition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxriver76%2FioBroker.face-recognition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxriver76%2FioBroker.face-recognition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foxriver76","download_url":"https://codeload.github.com/foxriver76/ioBroker.face-recognition/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240286519,"owners_count":19777353,"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-11T05:10:02.340Z","updated_at":"2025-11-14T09:01:49.940Z","avatar_url":"https://github.com/foxriver76.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Logo](admin/face-recognition.png)\n# ioBroker.face-recognition\n\n[![NPM version](https://img.shields.io/npm/v/iobroker.face-recognition.svg)](https://www.npmjs.com/package/iobroker.face-recognition)\n[![Downloads](https://img.shields.io/npm/dm/iobroker.face-recognition.svg)](https://www.npmjs.com/package/iobroker.face-recognition)\n![Number of Installations](https://iobroker.live/badges/face-recognition-installed.svg)\n![Current version in stable repository](https://iobroker.live/badges/face-recognition-stable.svg)\n\n[![NPM](https://nodei.co/npm/iobroker.face-recognition.png?downloads=true)](https://nodei.co/npm/iobroker.face-recognition/)\n\n**Tests:** ![Test and Release](https://github.com/foxriver76/ioBroker.face-recognition/workflows/Test%20and%20Release/badge.svg)\n\n## face-recognition adapter for ioBroker\n\nRecognize faces in image data\n\n## Developer manual\nThis section is intended for the developer. It can be deleted later\n\n### Getting started\n\nYou are almost done, only a few steps left:\n1. Create a new repository on GitHub with the name `ioBroker.face-recognition`\n\n1. Push all files to the GitHub repo. The creator has already set up the local repository for you:  \n    ```bash\n    git push origin main\n    ```\n\n1. Head over to [src/main.ts](src/main.ts) and start programming!\n\n### Best Practices\nWe've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should\ncheck them out. If you're already experienced, you should also take a look at them - you might learn something new :)\n\n### Scripts in `package.json`\nSeveral npm scripts are predefined for your convenience. You can run them using `npm run \u003cscriptname\u003e`\n| Script name | Description |\n|-------------|-------------|\n| `build` | Compile the TypeScript sources. |\n| `watch` | Compile the TypeScript sources and watch for changes. |\n| `test:ts` | Executes the tests you defined in `*.test.ts` files. |\n| `test:package` | Ensures your `package.json` and `io-package.json` are valid. |\n| `test:unit` | Tests the adapter startup with unit tests (fast, but might require module mocks to work). |\n| `test:integration` | Tests the adapter startup with an actual instance of ioBroker. |\n| `test` | Performs a minimal test run on package files and your tests. |\n| `check` | Performs a type-check on your code (without compiling anything). |\n| `lint` | Runs `ESLint` to check your code for formatting errors and potential bugs. |\n| `translate` | Translates texts in your adapter to all required languages, see [`@iobroker/adapter-dev`](https://github.com/ioBroker/adapter-dev#manage-translations) for more details. |\n| `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. |\n\n### Configuring the compilation\nThe adapter template uses [esbuild](https://esbuild.github.io/) to compile TypeScript and/or React code. You can configure many compilation settings \neither in `tsconfig.json` or by changing options for the build tasks. These options are described in detail in the\n[`@iobroker/adapter-dev` documentation](https://github.com/ioBroker/adapter-dev#compile-adapter-files).\n\n### Writing tests\nWhen done right, testing code is invaluable, because it gives you the \nconfidence to change your code while knowing exactly if and when \nsomething breaks. A good read on the topic of test-driven development \nis https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. \nAlthough writing tests before the code might seem strange at first, but it has very \nclear upsides.\n\nThe template provides you with basic tests for the adapter startup and package files.\nIt is recommended that you add your own tests into the mix.\n\n### Publishing the adapter\nUsing GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form \n`v\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`.\n\nSince you installed the release script, you can create a new\nrelease simply by calling:\n```bash\nnpm run release\n```\nAdditional command line options for the release script are explained in the\n[release-script documentation](https://github.com/AlCalzone/release-script#command-line).\n\nTo get your adapter released in ioBroker, please refer to the documentation \nof [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository).\n\n### Test the adapter manually with dev-server\nSince you set up `dev-server`, you can use it to run, test and debug your adapter.\n\nYou may start `dev-server` by calling from your dev directory:\n```bash\ndev-server watch\n```\n\nThe ioBroker.admin interface will then be available at http://localhost:8081/\n\nPlease refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details.\n\n## Changelog\n\u003c!--\n    Placeholder for the next version (at the beginning of the line):\n    ### **WORK IN PROGRESS**\n--\u003e\n\n### **WORK IN PROGRESS**\n* (foxriver76) initial release\n\n## License\nMIT License\n\nCopyright (c) 2022 Moritz Heusinger \u003cmoritz.heusinger@gmail.com\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nThe adapter icon has been designed using resources from Flaticon.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoxriver76%2Fiobroker.face-recognition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoxriver76%2Fiobroker.face-recognition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoxriver76%2Fiobroker.face-recognition/lists"}