Skip to content

Design Document

Travis Agne edited this page Apr 15, 2019 · 5 revisions

Functional Requirements

  1. Alter Time Parameters in a Visually Appealing way for the Data Metrics Given
  • Data sent to the Facade Database
  • Receive data from Facade Database
  • Condensing that data into a table
  • Condensing or expanding that data based on time parameters
  1. Comparison of Data Metrics across Repositories
  • Data from the Facade Database for analysis, projects, and the cache of the desired timeframes
  • Scripting language to populate data in the user interface (js)
  • Vue should be used for the creation of the user interface
  1. Comparison of Data Metrics within Repository
  • Information from the Facade Database
  • JavaScript and html will be used to manifest and position the items in the user interface
  • Vue will again be used for the use of this user interface

Database Design

DDL

  • Since we are using the Augur project database system. There is no need to create new database tables. Ghtorrent and Facade (Facade more specifically) should have all the information necessary for us to accomplish our goals.

User Interface File

  1. Changing Augur.js, going to edit set dates, this will allow date to be set by user input dynamically (this is for the first use case)
  2. Changing TableView.vue, this will take in the time parameters and show the data that fits inside these time parameters (this is for the first use case)

Model Files (Database Access)

augur/datasources/facade/routes.py augur/datasources/facade/facade.py

Controller Files (API or other)

router.js

Describe languages you need to use, and any gaps in skills on your team

  1. JavaScript
  2. Python
  • None of us have taken any class in python and have no real expertise in it
  1. html
  2. PHP