/wf-github-api

Primary LanguageJava

WF Exam

A Spring based web application that searches github public projects and does basic analytics based on the activity of the contributors commits.

Requirements.

  • Maven 3+
  • Java 1.8+
  • Github client

Setup

Clone the application. git clone https://github.com/mmagsino/wf-github-api.git

Run as development.

  • Run a maven command mvn clean spring-boot:run
  • Open browser and type http:localhost:8080
  • Rest API documentation http://localhost:8080/swagger-ui.html

Run as a jar file.

  • Build the package mvn clean package.
  • Build the package by skipping the integration test mvn clean package -Dmaven.test.skip=true.
  • Run on console java -jar target/wf-github-api-0.0.1-SNAPSHOT.jar.
  • Open browser and type http:localhost:8080
  • Rest API documentation http://localhost:8080/swagger-ui.html

Features

  • Search a public project from Github and return results.
  • Auto complete search feature.
  • Bookmarkable result pages.
  • Exposed Rest API and documentation.
  • List of contributors for a given project.
  • Basic analytics
    • Impact of each user on a given project.
    • Projection of commits on a timeline.
  • Contact: [michael03.25magsino@gmail.com, mike2_magsino@yahoo.com]