mirror of
https://github.com/rzuasti/oott.git
synced 2026-07-08 19:21:54 +02:00
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 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Sonnet 4.6
parent
4f5a228aec
commit
6d72ba7202
@@ -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
|
||||
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user