CalvinBackup/deflock
1
0
Fork 0
mirror of https://github.com/FoggedLens/deflock.git synced 2026-08-14 22:50:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Will Freeman
2026-04-26 22:53:56 -06:00
parent e8fcf30e5b
commit 36a7ee12e5
1 changed files with 25 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+25 -27
View File
@@ -13,59 +13,57 @@ I created this project after noticing the mass deployment of ALPRs in cities, to
### View ALPRs on a Map ### View ALPRs on a Map
Uses OpenStreetMap data to populate a map with crowdsourced locations of ALPRs, along with their type and direction they face. Uses OpenStreetMap data to populate a map with crowdsourced locations of ALPRs, along with their type and direction they face.
### Report ALPRs The map has become a separate repository, [deflockhopper_maps](https://github.com/FoggedLens/deflockhopper_maps).
Provides OSM tags for easy reporting of ALPRs based on brand on OSM's editing site. Eventually, this will be a native feature of the site.
### Learn About ALPRs
See photos of common ALPRs and learn about their capabilities. ### Report ALPRs
Provides instructions for using the [DeFlock App](https://deflock.org/app) or OpenStreetMap's [iD web editor](https://www.openstreetmap.org/edit) to report ALPRs using a standardized tagging system.
### Identify ALPRs
A constantly-growing repository of ALPR makes, models, and tagging instructions for OpenStreetMap, along with images for identifying them.
## Tech Stack ## Tech Stack
### Backend ### Backend
* Scala * TypeScript
* PekkoHTTP * Fastify API server
* Nginx * Cloudflare R2 for ALPR points and vector tiles
* OpenTelemetry
### Cloud ### Cloud
* AWS Lambda (for [region segmenting](serverless/alpr_clusters) and [counts](serverless/alpr_counts)) * AWS Lambda (for [region segmenting \[deprecated\]](serverless/alpr_clusters) and [counts](serverless/alpr_counts))
* AWS S3 * AWS S3 - phasing out for R2
* AWS ECR * AWS ECR
* Cloudflare as DNS + Proxy * Cloudflare as DNS + Proxy
* Directus CDN * Directus CDN
* Zammad helpdesk
### Frontend ### Frontend
* Vue3 * Vue3
* Vuetify (UI component library) * Vuetify
* Vue Leaflet (mapping library) * MapLibre GL
* Vue Leaflet \[deprecated\] - phasing out for MapLibre GL
### Services ### Services
* OpenStreetMap - Overpass API, Basic Map Tiles * OpenStreetMap - Overpass API, Basic Map Tiles \[deprecated\]
* Nominatim - Geocoding * Nominatim - Geocoding
## Usage ## Development
### Requirements ### Requirements
* node/npm * [bun](https://bun.sh/)
* scala/sbt
### Running Frontend ### Running Frontend
1. `cd webapp` 1. `cd webapp`
2. `npm i` 2. `bun i`
3. `npm run dev` 3. `bun dev`
### Running Backend ### Running Backend
#### Prerequisites 1. `cd api`
* JDK 11 2. `bun i`
* SBT 3. `bun dev`
1. `cd shotgun`
2. `sbt run`
### Building for Production
See [Dockerfile](./Dockerfile).
## Contributing ## Contributing