rzerres/advotracker
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

advotracker: the backend library

Browse Source 
Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>
This commit is contained in:
Ralf Zerres
2020-06-12 16:40:58 +02:00
parent f41589263b
commit d93dbd282b
2 changed files with 120 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
src/lib.rs Normal file
View File

@@ -0,0 +1,42 @@
//! # advotracker-framework
//!
//! `AdvoTracker` is a framework implemented in the `Rust` language
//! (![Rust.svg](../images/rust-logo-blk.svg)).
//! 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 (![OrbTk.svg](../images/orbtk-logo.svg)).
//!
//! 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.
//!
//! ![advotracker-framework.png](../images/advotracker-framework.png)
//!
//#![feature(extern_doc)]
//#[doc(include="../README.md")]