Smart Gate

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

Created by Jakub Jóźwiak and Mateusz Nestorowicz

Live app: smart-gate.netlify.app

UI/UX: figma.com/smart-gate

Storybook: smart-gate.chromatic.com

---

🚩 Table of Contents

• About
• Getting started
  • Prerequisites
  • General installation
• Packages Docs
• Conventional Commits
• Hygen - Code generator
• Available root scripts
• Changelog
• Contributors
• License

📖 About

System for managing and handling access to any physical entry home gate.

🎓 Getting started

Prerequisites

• Node.js >= 12
• Yarn >=1.22

General installation

yarn

📦 Packages Docs

• Backend:
  • Api
  • Device
• Frontend:
  • Client
• Utils:
  • CI scripts
  • E2E tests

📏 Conventional Commits

Commitlint checks if your commit messages meet the conventional commit format. Also it requires package scope (https://www.npmjs.com/package/@commitlint/config-lerna-scopes).

Structure:

type(package-name): general info

Structure with more inforamtion:

type(package-name): general info

- add login panel
- add avatar

Example:

feat(smart-gate-api): add comment section

Common types according to commitlint-config-conventional (based on the Angular convention) can be: conventional-commit-types. Header (first line) must not be longer than 100 characters.

For just validating your commit message without commiting it use terminal:

echo 'foo: bar' | commitlint

🤖 Hygen - Code generator

Hygen is the cli dev tool that provides the ability for generating scalable code. All code generation templates are defined in the __template directory. Remember to add created model to git files (typically those files are excluded from default). For more details check Hygen docs.

Available generators:

Package	Script	Description
client	hygen:element	Creates new standardize React component, story and style file

📝 Available root scripts

To run script, in terminal type yarn {script}.

Script	Description	Note
build
check	Runs linter, prettier, tests and ts-check in all packages
heroku-postbuild	It runs on heroku before api build
preinstall	Checks is yarn was used package manager	It runs automatically before every install
lint	Checks linter rules
lint:fix	Fix linter
stylelint	Checks stylelint rules for styled-components
prettier	Checks prettier rules
prettier:fix	Fix prettier
prepare	Install husky	It runs automatically after every install
removeNodeModules	Remove all node_modules from project (all packages)
sortPackageJson	Sort alphabetical all package.json in project
start	Used to run api package on heroku
start:ci	Start concurrently api and client in test mode
test	Runs tests for all packages
type-check	Checks TypeScript types for all packages

Changelog

Learn about the latest improvements.

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.