Ralf Zerres
5a9965751a
* advotracker: the framework project * crate/advotrackerdb: implementation of the database backend * crate/advotrackerd: implementation of the backend (daemon) * crate/adovtracker: implementaton of the application (CLI and GUI) Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>
49 lines
1.6 KiB
Rust
49 lines
1.6 KiB
Rust
#![crate_name = "advotracker"]
|
|
#![crate_type = "lib"]
|
|
|
|
//! # advotracker-framework
|
|
//!
|
|
//! 
|
|
//!
|
|
//! `AdvoTracker` is a framework implemented in the `Rust` language
|
|
//! ().
|
|
//! It assembles a client/server infrastructure needed to build a scalable, robust
|
|
//! tool used to keep track of legal mandate data within an online advice.
|
|
//!
|
|
//! ## Overview
|
|
//!
|
|
//! The framework will offer the following components:
|
|
//!
|
|
//! * Server side
|
|
//!
|
|
//! `advotrackerd` implements the server component. For example, it will handle all
|
|
//! the interaction with an underling database engine.
|
|
//!
|
|
//! * Client side
|
|
//!
|
|
//! `advotracker` is the client counterpart that represents the frontend.
|
|
//! To offer a operating system agnostic graphical interface, it will take advantage
|
|
//! of `OrbTk`, a Rust naitive GUI framework ().
|
|
//!
|
|
//! This component is the entry point for all `AdvoTracker` users.
|
|
//! All offered tasks are organized in roles. Thus, a user needs to authenticate agains
|
|
//! the system to make use of and access its assigned roles.
|
|
//!
|
|
//! The followin list is an
|
|
//! - enter and capture legal mandate date wile working in an online advice
|
|
//! - search inside the legal advices database
|
|
//! - export legal advices
|
|
//! - follow the history of legal advices
|
|
//! - get statistics about completed advices
|
|
//!
|
|
//! ## Workflow visualization
|
|
//!
|
|
//! The following image try to illustrate the major components and its workflow.
|
|
//!
|
|
//!
|
|
|
|
|
|
// eperimental features
|
|
//#![feature(extern_doc)]
|
|
//#[doc(include="../README.md")]
|