docs/

Overview

MakerLabs Access Control Management (ACM) System

## Quick Start

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

brew install yarn

git clone --recursive https://github.com/MakerLabsVan/makerlabs-acm
cd makerlabs-acm
git-crypt unlock ~/Downloads/MakerLabsVan_makerlabs-acm_git-crypt-key
rm ~/Downloads/MakerLabsVan_makerlabs-acm_git-crypt-key

yarn
yarn run login
yarn deploy.test
yarn firmware TARS

Dev Setup

System Diagram

Initial Project Setup

Known Issues

Migration/Configuration Changes Checklist

The following top-level directories are used to separate the different components/modules of the ACM system:

• _docs/, this section – overview, dev setup/onboarding, operating procedures: ...
• electrical/ (API Documentation) – KiCad: ...
• firmware/ (API Documentation) – C++/esp-idf: ...
• functions/ (API Documentation) – Dart/AWS Lambda/Firebase Functions: ...
• scripts/ (API Documentation) – Javascript/Google Apps Script: ...
• webcomponents/ (API Documentation) – Javascript/LitElement: ...