{"id":20348325,"url":"https://github.com/jozwiaczek/smart-gate","last_synced_at":"2025-07-27T06:35:42.080Z","repository":{"id":37096309,"uuid":"327942813","full_name":"Jozwiaczek/smart-gate","owner":"Jozwiaczek","description":"🔐  Open source system for handling access to any physical entry gate.","archived":false,"fork":false,"pushed_at":"2023-04-05T21:00:03.000Z","size":10365,"stargazers_count":23,"open_issues_count":72,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-05T06:26:26.491Z","etag":null,"topics":["gate","home-assistant","home-automation","home-gate","iot","javascript","monorepo","nestjs","open-source","pwa","react","siri-shortcuts","smart","smart-home","typescript","web"],"latest_commit_sha":null,"homepage":"https://smart-gate-docs.vercel.app","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/Jozwiaczek.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-01-08T15:38:53.000Z","updated_at":"2024-07-22T14:00:07.000Z","dependencies_parsed_at":"2024-11-14T22:30:15.892Z","dependency_job_id":null,"html_url":"https://github.com/Jozwiaczek/smart-gate","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/Jozwiaczek/smart-gate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jozwiaczek%2Fsmart-gate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jozwiaczek%2Fsmart-gate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jozwiaczek%2Fsmart-gate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jozwiaczek%2Fsmart-gate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jozwiaczek","download_url":"https://codeload.github.com/Jozwiaczek/smart-gate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jozwiaczek%2Fsmart-gate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267317703,"owners_count":24068481,"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","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["gate","home-assistant","home-automation","home-gate","iot","javascript","monorepo","nestjs","open-source","pwa","react","siri-shortcuts","smart","smart-home","typescript","web"],"created_at":"2024-11-14T22:19:53.438Z","updated_at":"2025-07-27T06:35:42.047Z","avatar_url":"https://github.com/Jozwiaczek.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eSmart Gate\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/Jozwiaczek/smart-gate\"\u003e\n        \u003cimg src=\"./readme-logo.png\" alt=\"smart gate logo\" width=\"192\" height=\"192\"/\u003e\n    \u003c/a\u003e\n    \u003cbr\u003e\n    \u003ci\u003e🔐 Open source system for handling access to any physical entry gate.\u003c/i\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003ci\u003eCreated by \u003ca href=\"https://github.com/Jozwiaczek\"\u003e\u003cb\u003eJakub Jóźwiak\u003c/b\u003e\u003c/a\u003e and \u003ca href='https://github.com/Mefjus'\u003e\u003cb\u003eMateusz Nestorowicz\u003c/b\u003e\u003c/a\u003e\u003c/i\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    Documentation:\n    \u003ca href=\"https://smart-gate-docs.vercel.app/\"\u003e\u003cstrong\u003esmart-gate-docs.vercel.app\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    UI/UX:\n    \u003ca href=\"https://www.figma.com/file/MqlnLhknWh1u0Ho8z1Oefe/Smart-Gate?node-id=0%3A1\"\u003e\u003cstrong\u003efigma.com/smart-gate\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    Storybook:\n    \u003ca href=\"https://main--6059282c88843d002106b484.chromatic.com\"\u003e\u003cstrong\u003esmart-gate.chromatic.com\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr/\u003e\n\n\u003cp align=\"center\"\u003e⚠️ Smart Gate is still in heavy development ⚠️\u003c/p\u003e\n\n\u003chr/\u003e\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/426cfdcb-e5e4-4067-97f2-c6106bde9195/deploy-status)](https://app.netlify.com/sites/smart-gate/deploys)\n[![Docs Status](https://img.shields.io/github/deployments/Jozwiaczek/smart-gate/Production?label=Docs\u0026logo=vercel\u0026logoColor=white)](https://smart-gate-docs.vercel.app/)\n[![CI](https://github.com/Jozwiaczek/smart-gate/actions/workflows/continous_integration.yml/badge.svg?branch=dev)](https://github.com/Jozwiaczek/smart-gate/actions/workflows/continous_integration.yml)\n[![Heroku Status](https://img.shields.io/github/deployments/Jozwiaczek/smart-gate/smart-gate-jj?label=Server\u0026logo=heroku\u0026logoColor=heroku)](https://img.shields.io/github/deployments/Jozwiaczek/smart-gate/smart-gate-jj?label=Server\u0026logo=heroku\u0026logoColor=heroku)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/426cfdcb-e5e4-4067-97f2-c6106bde9195/deploy-status)](https://app.netlify.com/sites/smart-gate/deploys)\n[![Vercel Status](https://img.shields.io/github/deployments/Jozwiaczek/smart-gate/production?label=Documentation\u0026logo=vercel\u0026logoColor=vercel)](https://img.shields.io/github/deployments/Jozwiaczek/smart-gate/production?label=Documentation\u0026logo=vercel\u0026logoColor=vercel)\n[![GitHub last commit](https://img.shields.io/github/last-commit/Jozwiaczek/smart-gate)](https://github.com/Jozwiaczek/smart-gate/commits)\n[![CodeFactor](https://www.codefactor.io/repository/github/jozwiaczek/smart-gate/badge)](https://www.codefactor.io/repository/github/jozwiaczek/smart-gate)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg)](#contributors-)\n[![Star on GitHub](https://img.shields.io/github/stars/Jozwiaczek/smart-gate.svg?style=social)](https://github.com/Jozwiaczek/smart-gate)\n\n## 🚩 Table of Contents\n\n- [About](#-about)\n- [Setup for your own usage](#setup-for-your-own-usage)\n  - [Deploy web application](#deploy-web-application)\n  - [Deploy server](#deploy-server)\n  - [Prepare your Raspberry Pi](#prepare-your-raspberry-pi)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n  - [Contributing Guidelines](#contributing-guidelines)\n  - [Want to Help?](#want-to-help?)\n  - [Code of Conduct](#code-of-conduct)\n- [Roadmap](#roadmap)\n- [Changelog](#changelog)\n- [Contributors](#contributors)\n- [License](#license)\n\n## 🔑 About\n\n![Smart gate info banner](banner-about.png)\n\nSystem for managing and handling access to any physical entry home gate or door.\nThe whole idea is to add smart control for your any already existed electric lock or gate.\n\nSounds familiar?\nRight, but there is one significant difference between others smart lock, it is **COMPLETELY FREE**.\n\nFrom physical side only what you have to do is to prepare [Raspberry Pi](https://www.raspberrypi.org/products/) and add some [3V Relay Module](https://www.google.com/search?q=relay+module+3v\u0026tbm=isch\u0026ved=2ahUKEwjll9aUt8_yAhVXvyoKHeMbBmgQ2-cCegQIABAA\u0026oq=relay+module+3v\u0026gs_lcp=CgNpbWcQAzIHCCMQ7wMQJzIGCAAQCBAeUKweWP8hYNEjaABwAHgAgAFliAGXApIBAzIuMZgBAKABAaoBC2d3cy13aXotaW1nwAEB\u0026sclient=img\u0026ei=o-wnYaW6Ldf-qgHjt5jABg\u0026bih=1329\u0026biw=2560\u0026rlz=1C5CHFA_enPL923PL923) between Raspberry and your gate to enable ability for opening.\n\nRest part of Smart Gate system is handled by predefined templates for simplifying process of deploying server, database, and web app.\nOnly what you have to do in this step is to click 2 buttons from [Setup for your own usage](#setup-for-your-own-usage) and fill provided secrets.\n\nAfter those steps You will transform your simply or even old gate/door into your private smart system.\n\nhttps://user-images.githubusercontent.com/29049653/131034360-aef67a76-4060-4953-8ed0-3694fe3e4809.mp4\n\n## 🚛 Quick setup for your own usage\n\n\u003e _Important note:_\n\u003e Bellow you will find only short and a temporary description on how to setup Smart Gate.\n\u003e\n\u003e More details will be added soon in [documentation website](https://smart-gate-docs.vercel.app/).\n\nIn order to use the Smart Gate system in your environment, you have to deploy your own instance\nof the client, server and database.\nTo make it as simple as possible there is already a prepared template for deploying all packages.\n\nWhat's important is that the whole setup and its usage is free, so You don't have to worry about any billing.\n\nWhy it's free because every part of this setup assumes usage of free tiers without any need to upgrades those pricing plans.\n\nYou only have to click the buttons below to deploy your own instances and fill up the required environment variables.\n\n### Deploy web application\n\nClick the button below to deploy [client package](packages/client/README.md) with prepared web application using predefined [Netlify](https://www.netlify.com) template.\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Jozwiaczek/smart-gate)\n\n### Deploy server\n\nClick the button below to deploy [api package](packages/api/README.md) with prepared server application using predefined [Heroku](https://www.heroku.com) template.\n\n[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/Jozwiaczek/smart-gate)\n\n### Prepare your Raspberry Pi\n\n#### One-Step Automated Install\n\nThose who want to get started quickly and conveniently may install Smart Gate using the following command:\n\n### `curl -sSL https://smart-gate-docs.vercel.app/install | bash`\n\n#### Alternative Installation Methods\n\nPiping to `bash` is controversial, as it prevents you from [reading code that is about to run](https://raw.githubusercontent.com/Jozwiaczek/smart-gate/main/packages/device/installer/installer.sh) on your system.\nTherefore, we provide these alternative installation methods which allow code review before installation:\n\n##### Method 1: Clone our repository and run\n\n```bash\ngit clone --depth 1 https://github.com/Jozwiaczek/smart-gate.git\ncd \"smart-gate/packages/device/installer\"\nsudo bash installer.sh\n```\n\n##### Method 2: Manually download the installer and run\n\n```bash\nwget -O installer.sh https://smart-gate-docs.vercel.app/install\nsudo bash installer.sh\n```\n\n#### Post install check\n\nAfter completed successfully installation check is everything working properly.\n\nYour Raspberry Pi should be initialized and connected with your server.\n\n_Check **standard logs**:_\n\n```bash\ncat /var/log/smart-gate-standard.log\n```\n\n_Check **error logs**:_\n\n```bash\ncat /var/log/smart-gate-error.log\n```\n\n## 📖 Documentation\n\nCheck out our [documentation website](https://smart-gate-docs.vercel.app/).\n\n## 🙏 Contributing\n\n### Contributing Guidelines\n\nRead the [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Smart Gate.\n\n### Want to Help?\n\nWant to file a bug, contribute some code, or improve documentation? Excellent!\n\nRead up on our guidelines for contributing and then check out one of our issues labeled as [![Help Wanted](https://img.shields.io/github/issues/Jozwiaczek/smart-gate/help%20wanted.svg)](https://github.com/Jozwiaczek/smart-gate/issues?q=is%3Aopen+is%3Aissue+label%3A%22help-wanted%22) or [![Good First Issue](https://img.shields.io/github/issues/Jozwiaczek/smart-gate/good%20first%20issue.svg)](https://github.com/Jozwiaczek/smart-gate/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).\n\n### Code of Conduct\n\nHelp us keep Smart Gate open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## 📍 Roadmap\n\nThe future plans and high priority features and enhancements can be found in the [roadmap](https://github.com/Jozwiaczek/smart-gate/projects/1).\n\n## 📈 Changelog\n\nFor details about the latest updates check the [changelog](CHANGELOG.md).\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/Jozwiaczek\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/29049653?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJakub Jóźwiak\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/Jozwiaczek/smart-gate/commits?author=Jozwiaczek\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/Jozwiaczek/smart-gate/commits?author=Jozwiaczek\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#design-Jozwiaczek\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-Jozwiaczek\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#infra-Jozwiaczek\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"https://github.com/Jozwiaczek/smart-gate/pulls?q=is%3Apr+reviewed-by%3AJozwiaczek\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/Mefjus\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/29005327?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMefjus\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/Jozwiaczek/smart-gate/commits?author=Mefjus\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#ideas-Mefjus\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/Jozwiaczek/smart-gate/pulls?q=is%3Apr+reviewed-by%3AMefjus\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/nikofiko123\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/39961079?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003enikofiko123\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#design-nikofiko123\" title=\"Design\"\u003e🎨\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/Vatras\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/4075877?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eVatras\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/Jozwiaczek/smart-gate/pulls?q=is%3Apr+reviewed-by%3AVatras\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## License\n\nCopyright 2020 Jakub Jóźwiak.\nLicensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjozwiaczek%2Fsmart-gate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjozwiaczek%2Fsmart-gate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjozwiaczek%2Fsmart-gate/lists"}