GitHubSourceCodeCollector
=========================

Collect source code details from GitHub based on URL and branch

This project uses Spring Boot to package the collector as an executable JAR with dependencies.

Building and Deploying
--------------------------------------

Run
```
mvn install
```
to package the collector into an executable JAR file. Copy this file to your server and launch it using :
```
java -JAR github-collector.jar
```
You will need to provide an **application.properties** file that contains information about how
to connect to the Dashboard MongoDB database instance, as well as properties the Github collector requires. See
the Spring Boot [documentation](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-application-property-files)
for information about sourcing this properties file.

###Sample application.properties file
--------------------------------------
    #Database Name 
    database=dashboarddb

    #Database HostName - default is localhost
    dbhost=10.0.1.1

    #Database Port - default is 27017
    dbport=9999

    #Database Username - default is blank
    dbusername=db

    #Database Password - default is blank
    dbpassword=dbpass

    #Collector schedule (required)
    github.cron=0 0/5 * * * *

    github.host=github.com

    #Maximum number of days to go back in time when fetching commits
    github.commitThresholdDays=15

GitHubSourceCodeCollector
=========================

Collect source code details from GitHub based on URL and branch

This project uses Spring Boot to package the collector as an executable JAR with dependencies.

Building and Deploying
--------------------------------------

Run
```
mvn install
```
to package the collector into an executable JAR file. Copy this file to your server and launch it using :
```
java -JAR github-collector.jar
```
You will need to provide an **application.properties** file that contains information about how
to connect to the Dashboard MongoDB database instance, as well as properties the Github collector requires. See
the Spring Boot [documentation](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-application-property-files)
for information about sourcing this properties file.

###Sample application.properties file
--------------------------------------
    #Database Name 
    database=dashboard

    #Database HostName - default is localhost
    dbhost=10.0.1.1

    #Database Port - default is 27017
    dbport=9999

    #Database Username - default is blank
    dbusername=db

    #Database Password - default is blank
    dbpassword=dbpass

    #Collector schedule (required)
    github.cron=0 0/5 * * * *

    github.host=github.com

    #Maximum number of days to go back in time when fetching commits
    github.commitThresholdDays=15

Fix mongoDB database name as: dashboard
Fix mongoDB database name as: dashboard

Fix the values for creating database in MongoDB as its seems like the documentation in each module has many different references for the database name as either dashboard or dashboarddb which will introduce confusion. Fix the values accross all setup instructions to use mongoDB database name as: dashboard
