Update readme
This commit is contained in:
@@ -1,9 +1,10 @@
|
||||
## Gatekeeper - Door access system
|
||||
#### Status: WIP - getting there o.o
|
||||
#### Status: "WORKING" - Base functionality is there, mayor issues
|
||||
|
||||
Start prod server `nix run`<br>
|
||||
Start dev server `nix run .#dev` or `nix run .#dev -- {args}`<br>
|
||||
Interactive dev with `nix develop`, then sync deps with `uv sync`<br>
|
||||
There is a nix module you can use by importing `inputs.gatekeeper.nixosModules.gatekeeper`<br>
|
||||
Swagger UI @ http://127.0.0.1:8000/api/v1/docs<br>
|
||||
OpenApi @ http://127.0.0.1:8000/api/v1/openapi.json<br>
|
||||
|
||||
@@ -33,17 +34,13 @@ Range: The range of the ACR1552U was much better at over 60mm (almost 70mm if yo
|
||||
|
||||
|
||||
#### Issues:
|
||||
- cards can only unlock, not lock
|
||||
- documentation missing
|
||||
- raspberry pi image not working
|
||||
- no door state
|
||||
- no door operations
|
||||
- hardcoded secret key in auth.py -> centralise env var loading
|
||||
- i don't like the error handling in the scanner - doesn't pass errors correctly
|
||||
- cors for frontend: https://fastapi.tiangolo.com/tutorial/cors
|
||||
- Load cors from env var or something
|
||||
- BackgroundScanner shouldn't get a single session for the whole lifecycle
|
||||
- input validation maybe
|
||||
- too many imports
|
||||
- inconsistent logging (request logging?)
|
||||
- rate limiting maybe
|
||||
- pretty sure the controllers are doing too much stuff
|
||||
|
||||
Reference in New Issue
Block a user