/augur-group26

Primary LanguageJavaScriptMIT LicenseMIT

Augur

branch status
master Build Status
dev Build Status

About Augur

Augur is focused on prototyping open source software metrics.

Functionally, Augur is a prototyped implementation of the Linux Foundation's CHAOSS Project on open source software metrics. Technically, Augur is a Flask web application, Python library and REST server that presents metrics on open source software development project health and sustainability.

Getting Started


Vagrant

The quickest way to get started working on Augur is by using Vagrant to spin up a virtual machine (VM) that comes with Augur already installed. We'll do all the work of setting up and installing dependencies, leaving you free to jump right into making something awesome.

Caveat: if you’re a super nerd who likes to have total control over your development environment, there’s a local installation link at the bottom of this page. For the rest of you, Vagrant is the way to go, especially if you've had trouble getting all the dependcies installed locally, are not comfortable installing them yourself, or are using an OS for which we don't currently support local installation. We currently only support local installation for macOS and most flavors of Linux.

Windows installation instructions using Vagrant can be found here.

Dependencies

Developer - Instructions

The directions found in this link are for installation on mac OS and amazon ec2 instance.

https://github.com/computationalmystic/augur-group26/blob/master/Sprint%204/developer-instructions.md

Current State of Group 26 Use Cases and Issues

The following link is to inform users of the current progress of group 26's use cases and issues.

https://github.com/computationalmystic/augur-group26/blob/master/Sprint%204/Current_State.md

Expected User Deliverable Product

http://ec2-13-58-174-130.us-east-2.compute.amazonaws.com:3333/single/github.com%2Ftwitter%2Ftwemoji/commits#

Group 26 added a new tab to the original Augur program called Commits. In lines you will find two new and functional graphs. The first graph, is a tick graph. It shows the number of commit by the 10 authors as Percentage in year month or continuous. The second graph, is a zoomable graph. It shows the commits of code added by the top 10 authors. Its zoom function works by hovering over the graph and scrolling up or down. Giving the user a way to find exact values in the graph that spans a large difference in values.

Guidelines

To contribute to Augur, please check out our development guide and notes on making contributions. Also, please note our code of conduct. We want Augur to be a welcoming development community that is open to everyone.

Roadmap

Our technical, outreach, and academic goals roadmap.

License and Copyright

Copyright © 2018 University of Nebraska at Omaha, University of Missouri and CHAOSS Project at the Linux Foundation

Augur is free software: you can redistribute it and/or modify it under the terms of the MIT License as published by the Open Source Initiative. See the file LICENSE for more details.

(This work has been funded through the Alfred P. Sloan Foundation)