nkalscheuer / mavericks

Mavericks Project in CMPS 115 Intro to Software Engineering

Mavericks

Version 1.0.1 Affogato UCSC CMPS 115 Summer 2018 project

Overview

The Mavericks: is separate link in the FileOpen website that allows authors, individuals who send their files to FileOpen to be encrypted and shared via a separate link, to see the analytics behind the file being shared.

Team Members

Nicholas Kalscheuer	Scrum Master - S3	[e-mail]
Randall Li	Scrum Master - S2	[e-mail]
Ciara Fitzpatrick	Scrum Master - S1	[e-mail]
Sharad Shrestha	Scrum Master - S3	[e-mail]

Technology

Project Management

• Trello - Online Scrum board
• Slack - Team communication
• Google Meet - Online Scrum/Emergency Meetings
• Github - Software Management

Programming Languages

• HTML
• CSS
• JavaScript

Frameworks/Libraries/APIs

• D3
• TopoJSON
• D3
• Vuetify
• Google Maps API

Get Started

Dependencies

node yarn

Set up

1. Install node, yarn.
2. After cloning the repo to your local machine, install the dependencies described in the package.json, by using your package manager. If you are using yarn, run this command in the project's directory: yarn install
3. Run the application. yarn run dev

File overview

FoNodeModules directory:

• FoPreprocessor.js (This is a modular function that was used for collecting number of opens per user.)

router directory:

• index.js
• routes.js (Routes page that directs any individual to the analytics)

Analytics directory:

• Dashboard.vue
• DashboardDemo.vue (The static default page there is nothing loaded on the page.)

Document directory:

• OpenBar.vue (This page show a bar chart of average session time of a document by user and the number of times it was opened.)
• OpenBubble.vue (This page shows a bubble chart of number of times a document was opened per user and categorizes it by email domain.)
• OpenChart.vue (This page shows the number of times a document was opened per user by month and day, similar to Github's contribution heat chart.)
• OpenGoogle.vue (This page shows the locations of where users opened the document.)

Resources

D3 Official Site

Icons - Icons that can be used to make the application more visual and less wordy

VueJS Getting Started

Vuetify - VueJS library that allows to easily make pretty components (any component prefaced with v- comes from it)

Sharad's bubble chart demo: https://sharad97.github.io/CMPS-115/project_testing/bublechart_legend2.html

• NOTE: The project doesn't use the latest Vuetify