Skip to content
Simon Geering edited this page Sep 9, 2020 · 16 revisions
  1. Overview
    1.1 A note on technologies used
  2. WIKI Contents
    2.1 Architecture
    2.2 Individual Modules
    2.3 Misc Notes

Overview

The system is intended to act as a personal information management system, assisting with the admin of day to day life for an individual handling home finances and running a household along with day to day operation of a "side project" small business venture.

A note on technologies used

Note that the intent of the project is to show a range of technologies. As such, while the architecture is realistic there may be an excessive number of project types in use in order to highlight a number of possible approaches.

For example, the project includes multiple versions of the same UI using various UI platforms such as Desktop, Mobile or various Web technologies, where a real-world system may only utilise a subset of these.

WIKI Contents

Architecture

Details the various aspects of the application architecture.

Status Wiki Page Link Description
V1.0.0 Component Diagram UML Component Diagram - Showing assembly dependency hierarchy
TODO Deployment Diagram UML Deployment Diagram - Showing how assemblies map to infrastructure

Misc Notes

All other miscellaneous notes that don't belong in the other sections.

Status Page Description
WIP CLI Tools Notes on the use of various CLI tool commands

Individual Modules

Detailed documentation on the individual modules of the system.

Each page includes:

  • A UML UseCase diagram giving an overview of the functional capabilities provided by the module.
  • User stories for each feature of the module, including a link to an associated GitHub Issue.
  • Links to any additional associated GitHub Issues.
  • Details of the UI design
    • Sketch mockups of the screens layouts
    • Where appropriate UX interaction flow diagrams.
  • Details of the Database Schema
    • An overview Entity-Relationship diagram showing the main relationships between tables.
    • A detailed Entity-Relationship Model diagram showing the full database schema.
Status Individual Modules Description
TODO Dashboard A BI dashboard that provides an overview of the system and links to more detailed reports
WIP Accounts Management of personal or small business bank accounts.
WIP Asset Register (TODO: Add Description)
WIP Budget (TODO: Add Description)
TODO Mail (TODO: Add Description)
WIP Calendar (TODO: Add Description)
WIP Contacts (TODO: Add Description)
WIP Tasks (TODO: Add Description)
WIP Documents (TODO: Add Description)
TODO Reports (TODO: Add Description)
WIP Core Helper module used by all other modules.

Home

Architecture [WIP]
Design Decisions
CLI Tools [WIP]


Individual Modules
Dashboard [TODO]
Accounts [WIP]
Asset Register [WIP]
Budget [WIP]
Mail [TODO]
Calendar [WIP]
Contacts [WIP]
Tasks [WIP]
Documents [WIP]
Reports [TODO]
Core [WIP]

Clone this wiki locally