Skip to content

README.md

Latest commit

 

History

History
55 lines (39 loc) · 1.7 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.7 KB

FamiLAB Access Controller API

Goals

Create a single, authoritative data source for members that the access control system can tie into.

  • Expand the door control system to be able to support other devices.
  • Allow "dumb" device control that only needs to make a single api call to check for access.

Design

A google spreadsheet will be used as the authoritative data source for badges. The accessController API will provide a single endpoint with two variables: badgeId and location. When a request comes in, a canonical google sheet will be queried via Google's APIs to retrieve the list of badges and their access.

From the returned spreadsheet, a row matching the badgeId will be checked for a matching value for location. accessController API will then return a boolean true/false.

Development Setup

  1. Install Node 18+
  2. Globally install pnpm 
    npm install --global pnpm
  3. Install Node packages 
    pnpm install

Development

To run the code as a development server, run:

npm run dev

Development Status:

Complete:

  • Create GET endpoint supporting two variables: badgeId, location
  • Query google spreadsheet using google API
  • Parse retrieved sheet to JSON
  • Compare incoming badgeId and location to parsed json and return [true, false]
  • Log requests to disk (and console.)

TODO:

  • Provide a way to retrieve logs that's nicer than grepping the .log file.
  • Rotate logfile occasionally if it ends up growing too big.
  • Create a default badge list to be stored in the .env file to use when device starts in offline.
  • Cache most recent parsed spreadsheet for use when internet is offline