README
¶
Member Dashboard
Introduction
Member Dashboard is the source of truth for who has access to what at the makerspace.
Membership statuses will be pulled down from Payment Providers on a daily basis.
If a member has made a payment in the past 30 days, they will be considered an active member.
High level
- The server pulls payment information from paypal (and stores in the db) so we can tell who is currently an active member
- the server will maintain access lists and periodically push those access lists to the microcontrollers on the network
- The microcontroller (aka a resource) stores its access list locally so it's not dependant on the network when someone wants to access the space
Run locally
# install frontend deps
make deps-frontend
make
note that this doesn't setup the mqtt server and it doesn't communicate with any mqtt devices
Documentation
Documentation can be found here
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
datastore defines an interface for persisting data.
|
datastore defines an interface for persisting data. |
|
integrations contains interfaces for external packages
|
integrations contains interfaces for external packages |
|
models contains definitions of structs.
|
models contains definitions of structs. |
|
swagger
The swagger dir includes types to help with generating swagger documentation
|
The swagger dir includes types to help with generating swagger documentation |
|
pkg contains library code that could potentially be used externally
|
pkg contains library code that could potentially be used externally |
|
paypal
Package paypal is used to fetch subscription info from the paypal api
|
Package paypal is used to fetch subscription info from the paypal api |
|
services is where most business logic exists
|
services is where most business logic exists |
|
test includes scripts and programs that can be used to assist in the with testing
|
test includes scripts and programs that can be used to assist in the with testing |
|
cmd
command
|
|
|
communication code
|
communication code |
|
http/v1
v1 is the package that implements the http api
|
v1 is the package that implements the http api |
|
mqtt/v1
v1 is a package that implements the mqtt handler
|
v1 is a package that implements the mqtt handler |
Click to show internal directories.
Click to hide internal directories.