mirror of
https://github.com/rzuasti/oott.git
synced 2026-07-08 19:21:54 +02:00
2.3 KiB
2.3 KiB
Project OOTT
OOTT is an easy to setup network monitoring and alert system aimed at notifying when new or unknown devices join a local area network.
It has two major components:
- A backend service that runs the monitoring and other processes and provides a REST API. This is built with Rust.
- A front-end that enables the user to configure the system and access the data it stores. This is built with Flutter - a front-end framework based on the Dart language.
Code style
For Rust code:
- Use the standard Rust style guide
- Use
rustfmtto format the code
For Flutter/Dart code:
- Use the standard Dart style guide
- Use
dart format --output showto format the code
Project commands
- `` - Run the backend
- `` - Run the front-end for the web
- `` - Run the backend tests
Architecture
General
- All backend source code is under the
backend/folder - All front-end source code is under the
frontend/folder - All interactions between the front-end and the backend are via the backend REST API
Backend
- System state and events are stored in a SQLite database (
oott.dbby default) which is accessed and managed exclusively by the backend via a data access layer (db.rsand files under thebackend/src/db/folder) - Database structure is handled through incremental migrations (stored under the
backend/database_migrationsfolder). Each set of structural changes should be a new database migration file. - The backend's entry point is
src/main.rswhich starts two threads using the Tokyo framework: one for the network scanning process and another one for the web server that exposes the API and hosts the Flutter app (front-end) assets when deployed in a live environment (ie not development)
Front-end
- The front-end's entry point is
lib/main.dart - It uses the Material 3 framework for Flutter
- The application needs to be responsive and adapt to a web experience in the desktop, tablets and phones
- The application is also available in iOS and Android as a native experience (via de App Store and Play store)