Smart Gate

🔐 Open source system for handling access to any physical entry gate.

Created by Jakub Jóźwiak and Mateusz Nestorowicz

Documentation: smart-gate-docs.vercel.app

UI/UX: figma.com/smart-gate

Storybook: smart-gate.chromatic.com

⚠️ Smart Gate is still in heavy development ⚠️

🚩 Table of Contents

• About
• Setup for your own usage
  • Deploy web application
  • Deploy server
  • Prepare your Raspberry Pi
• Documentation
• Contributing
  • Contributing Guidelines
  • Want to Help?
  • Code of Conduct
• Roadmap
• Changelog
• Contributors
• License

🔑 About

System for managing and handling access to any physical entry home gate or door. The whole idea is to add smart control for your any already existed electric lock or gate.

Sounds familiar? Right, but there is one significant difference between others smart lock, it is COMPLETELY FREE.

From physical side only what you have to do is to prepare Raspberry Pi and add some 3V Relay Module between Raspberry and your gate to enable ability for opening.

Rest part of Smart Gate system is handled by predefined templates for simplifying process of deploying server, database, and web app. Only what you have to do in this step is to click 2 buttons from Setup for your own usage and fill provided secrets.

After those steps You will transform your simply or even old gate/door into your private smart system.

https://user-images.githubusercontent.com/29049653/131034360-aef67a76-4060-4953-8ed0-3694fe3e4809.mp4

🚛 Quick setup for your own usage

Important note: Bellow you will find only short and a temporary description on how to setup Smart Gate.

More details will be added soon in documentation website.

In order to use the Smart Gate system in your environment, you have to deploy your own instance of the client, server and database. To make it as simple as possible there is already a prepared template for deploying all packages.

What's important is that the whole setup and its usage is free, so You don't have to worry about any billing.

Why it's free because every part of this setup assumes usage of free tiers without any need to upgrades those pricing plans.

You only have to click the buttons below to deploy your own instances and fill up the required environment variables.

Deploy web application

Click the button below to deploy client package with prepared web application using predefined Netlify template.

Deploy server

Click the button below to deploy api package with prepared server application using predefined Heroku template.

Prepare your Raspberry Pi

One-Step Automated Install

Those who want to get started quickly and conveniently may install Smart Gate using the following command:

curl -sSL https://smart-gate-docs.vercel.app/install | bash

Alternative Installation Methods

Piping to bash is controversial, as it prevents you from reading code that is about to run on your system. Therefore, we provide these alternative installation methods which allow code review before installation:

Method 1: Clone our repository and run

git clone --depth 1 https://github.com/Jozwiaczek/smart-gate.git
cd "smart-gate/packages/device/installer"
sudo bash installer.sh

Method 2: Manually download the installer and run

wget -O installer.sh https://smart-gate-docs.vercel.app/install
sudo bash installer.sh

Post install check

After completed successfully installation check is everything working properly.

Your Raspberry Pi should be initialized and connected with your server.

Check standard logs:

cat /var/log/smart-gate-standard.log

Check error logs:

cat /var/log/smart-gate-error.log

📖 Documentation

Check out our documentation website.

🙏 Contributing

Contributing Guidelines

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Smart Gate.

Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent!

Read up on our guidelines for contributing and then check out one of our issues labeled as or .

Code of Conduct

Help us keep Smart Gate open and inclusive. Please read and follow our Code of Conduct.

📍 Roadmap

The future plans and high priority features and enhancements can be found in the roadmap.

📈 Changelog

For details about the latest updates check the changelog.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jakub Jóźwiak 💻 📖 🎨 🤔 🚇 👀

Mefjus 💻 🤔 👀

nikofiko123 🎨

Vatras 👀

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Copyright 2020 Jakub Jóźwiak. Licensed under the MIT license.