From 6d72ba72028ce4a16fef6208bd523b5c48858870 Mon Sep 17 00:00:00 2001 From: rzuasti Date: Wed, 27 May 2026 14:09:02 -0400 Subject: [PATCH] Update project docs and dev environment - Add linter commands to CLAUDE.md - Add clippy to Nix dev shell - Add TODO.md with project task list Co-Authored-By: Claude Sonnet 4.6 --- CLAUDE.md | 4 ++++ TODO.md | 24 ++++++++++++++++++++++++ flake.nix | 1 + 3 files changed, 29 insertions(+) create mode 100644 TODO.md diff --git a/CLAUDE.md b/CLAUDE.md index bd9541b..96add05 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -22,6 +22,8 @@ For Flutter/Dart code: - `sudo cargo run` from the `backend/` folder - Run the backend (you need sudo to enable the process to attach itself to the network channel) - `flutter run -d web-server --web-port 3333` from the `frontend/` folder - Run the front-end for the web - `run_tests.sh` - Run the backend tests +- `cargo clippy` - Run the clippy linter for Rust code +- `dart analyze` - Run the Dart linter ## Architecture @@ -47,3 +49,5 @@ For Flutter/Dart code: - Code must be as simple as possible, human readable and modularized - ALWAYS write unit tests for new or modified backend components - ALWAYS run all tests after making a new change and do not continue until all tests pass +- When adding a new API endpoint, ALWAYS wire it to the OpenAPI generation +- When adding a significant chunk of new code (either Rust or Dart), run the corresponding linter diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..3057978 --- /dev/null +++ b/TODO.md @@ -0,0 +1,24 @@ +# OOTT ToDo list + +- [x] Add linting to CLAUDE.md for both Rust and Dart + +## Backend + +- [x] Add Swagger and API docs (OpenAPI) +- [ ] Record an activity log in the database + - [ ] One event for each device appearance + +## Frontend + +- [ ] List recorded devices +- [ ] Forget a device +- [ ] View detailed log of device activity (based on event log in the backend) +- [ ] Scan process monitor and summary page + - [ ] Is the scan process running + - [ ] Last run (when, how long did it take, how many devices did it found) + - [ ] When is the next run +- [ ] Rework notifications page into a homepage for the app + - [ ] Notifications list + - [ ] Summary of devices recorded (how many in total, how many seen in the last day, how many not seen for a week) + - [ ] Scanning process summary (is it running, when will it run again) +- [ ] About page diff --git a/flake.nix b/flake.nix index 6dcbc5d..a415838 100644 --- a/flake.nix +++ b/flake.nix @@ -51,6 +51,7 @@ androidSdk jdk17 claude-code + clippy # Rust linter ]; # fish > all