{"id":21648972,"url":"https://github.com/betterengineering/open-keyless","last_synced_at":"2025-06-12T04:10:02.589Z","repository":{"id":49128060,"uuid":"166902871","full_name":"betterengineering/open-keyless","owner":"betterengineering","description":"An open source, open hardware, keyless entry system for contactless key cards","archived":false,"fork":false,"pushed_at":"2024-01-09T19:27:03.000Z","size":283,"stargazers_count":7,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T15:33:42.517Z","etag":null,"topics":["golang","nfc","open-hardware","open-source","rfid"],"latest_commit_sha":null,"homepage":"","language":"Go","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/betterengineering.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":"2019-01-22T01:02:48.000Z","updated_at":"2024-07-02T18:06:46.000Z","dependencies_parsed_at":"2024-06-19T20:05:32.747Z","dependency_job_id":"1e183394-5916-4b8d-9085-a102ea79d66f","html_url":"https://github.com/betterengineering/open-keyless","commit_stats":{"total_commits":30,"total_committers":3,"mean_commits":10.0,"dds":0.06666666666666665,"last_synced_commit":"a7c60cfb2b97bb0130fb077cf995282d684b4b44"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betterengineering%2Fopen-keyless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betterengineering%2Fopen-keyless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betterengineering%2Fopen-keyless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betterengineering%2Fopen-keyless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/betterengineering","download_url":"https://codeload.github.com/betterengineering/open-keyless/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248468197,"owners_count":21108774,"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":["golang","nfc","open-hardware","open-source","rfid"],"created_at":"2024-11-25T07:00:40.767Z","updated_at":"2025-04-11T19:40:27.145Z","avatar_url":"https://github.com/betterengineering.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open Keyless\n[![Build Status](https://cloud.drone.io/api/badges/betterengineering/open-keyless/status.svg)](https://cloud.drone.io/betterengineering/open-keyless)\n[![GoDoc](https://godoc.org/github.com/betterengineering/open-keyless?status.svg)](https://godoc.org/github.com/betterengineering/open-keyless)\n\nOpen Keyless is a keyless entry system for contactless key cards. This project includes all of the necessary software,\nprinted circuit board designs, 3D models, and documentation to build an RFID based badge reader and controller.\n\nNote: this project is under development and has not yet been completed. Once a functioning version of this\nproject exists, this message will be removed and the release will be added as a github release.\n\n## Installation\nTo install the latest release, run the following from your Raspberry Pi:\n```\ncurl -LO https://github.com/betterengineering/open-keyless/releases/latest/download/install.sh\nchmod +x ./install.sh\nsudo ./install.sh\n```\n\n## Documentation\nThe documentation for Open Keyless is kept in the repo! Checkout the [Overview](docs/overview.md) for a starting point.\n\n## Development\nThis project uses Go 1.11 modules! If you have Go 1.11 or later installed, no other project setup is necessary.\n\n### Testing\nTo run tests locally, run the following:\n```bash\nmake test\n```\n\nTo include integration tests, run the following:\n```bash\nmake test-full\n```\n\n### Mocks\nThis project uses Golang's [mockgen](https://github.com/golang/mock) tool to generate mocks for interfaces. To regenerate mocks, run the following:\n```bash\nmake mocks\n```\n\n### Libnfc\nTo develop locally, you will need libnfc installed. I would like to remove this as a dependency in the future, but alas,\nit is a dependency for now.\n\nFor MacOS, run the following:\n```bash\nbrew install libnfc\n```\n\nFor Debian based Linux distros, run the following:\n```bash\napt-get install -y libnfc-dev\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetterengineering%2Fopen-keyless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbetterengineering%2Fopen-keyless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetterengineering%2Fopen-keyless/lists"}