EECS2311 Software Development Project

Description

A desktop app that can draw customizable Venn diagrams.

Getting Started

Follow the installation instructions below, when installed and on the home page as shown above, click Create New to start a new VennCreate Project.

Retrieve an Existing Project

On the home menu showed above, click "Get Existing". Your file explorer will then be opened and you may search for an existing venn diagram.

Folder Structure

• [VennCreate]
  • [build/libs]
    • VennCreate.jar
  • [src/main]
    • [java]
      • [controllers]
      • [models]
      • [views]
    • [resources]
  • [src/test]
    • [java]
      • [tests]
• [Documents]
  • Venn-DD.pdf
  • Venn-RD.pdf
  • Venn-TD.pdf
  • Venn-UM.pdf

User Interface

MainFrame
┌─────────────────────────────────────┐
│               MenuBar               │
├─────────────────────────────────────┤
│        │                            │
│        │                            │
│ NavBar │       shapeScence          │
│        │                            │
│        │                            │
└─────────────────────────────────────┘

Design Pattern

Model–View–Controller

┌───────────┐     ┌───────────┐     ┌───────────────┐
│   Model   │     │   View    │     │  Controller   │
└───────────┘     └───────────┘     └───────────────┘

• Model: Mathematical sets serves as the primary logic of Venn diagrams.
• View: Implemented using JavaFX.
• Controller: Mouse and key listener.

Installation

Please find the latest release in here.

To run, either double-click or use command line java -jar ./VennCreate.jar.

Documents

• Design Document
• Requirements Document
• Testing Document
• User Manual

Group Members

• Chidalu Agbakwa (216337784)
• Shangru Li (214488993)
• Jihal Patel (216376436)
• Robert Suwary (215446016)

License

See LICENSE.