update readmes

This commit is contained in:
Will Freeman
2024-11-30 17:06:07 -07:00
parent f3966fede2
commit 050c9a8f8c
4 changed files with 20 additions and 0 deletions

View File

@@ -28,6 +28,11 @@ _Likely to change soon._
* PekkoHTTP
* Nginx
### Cloud
* AWS Lambda (for [clustering](serverless/alpr_clusters) and [counts](serverless/alpr_counts))
* AWS S3
* AWS ECR
### Frontend
* Vue3
* Vuetify (UI component library)

3
serverless/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Serverless
These microservices collect additional data used in DeFlock, such as total ALPR counts and map clusters.

View File

@@ -0,0 +1,6 @@
# ALPR Clusters
Generates clusters (the blobs shown on the map when zoomed out far) daily using OSM data. OSM's Overpass API is used to query for all locations of ALPRs, then a clustering algorithm is used. The clustered data is stored in a JSON file in an S3 bucket.
## Deploying
To build and deploy the Docker image, run `./deploy.sh`.

View File

@@ -0,0 +1,6 @@
# ALPR Counts
Counts total ALPRs reported in the OSM database, hourly. OSM's Overpass API is used to query for counts of all ALPRs and ALPRs in the United States. The counts are stored in a JSON file in an S3 bucket.
## Deploying
This Lambda uses a zip file, so from the `/terraform` directory, you can run `terraform apply` after making changes, and it should detect the changes, rebuild the zip, and update the Lambda's function code.