Merge pull request #49 from glugg23/develop

Final pull request!
glugg23 · May 11, 2019 · d89a447 · d89a447
2 parents 95fc6d4 + 17f1e09
commit d89a447
Show file tree

Hide file tree

Showing 37 changed files with 723 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,16 @@
+# SET08103 Group 20
+
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Release](https://img.shields.io/github/release/glugg23/SET08103-G20.svg)](#)
-![](https://img.shields.io/github/languages/code-size/glugg23/SET08103-G20.svg?style=flat)
-# SET08103 Group 20
-#### Development Branch
-[![Build Status](https://travis-ci.org/glugg23/SET08103-G20.svg?branch=develop)](https://travis-ci.org/glugg23/SET08103-G20)
+[![codecov](https://codecov.io/gh/glugg23/SET08103-G20/branch/master/graph/badge.svg)](https://codecov.io/gh/glugg23/SET08103-G20)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/glugg23/SET08103-G20.svg)
+
 #### Master Branch
 [![Build Status](https://travis-ci.org/glugg23/SET08103-G20.svg?branch=master)](https://travis-ci.org/glugg23/SET08103-G20)
 
+#### Development Branch
+[![Build Status](https://travis-ci.org/glugg23/SET08103-G20.svg?branch=develop)](https://travis-ci.org/glugg23/SET08103-G20)
+
 ## Introduction
 This is group 20's coursework submission for the SET08103 course at Edinburgh Napier University
 
@@ -16,15 +20,60 @@ This is group 20's coursework submission for the SET08103 course at Edinburgh Na
 - Maven 4.0.0
 - JDK 11.0.2
 
-
 ## Build from source
 ```
-mvn install
-docker-compose up --build --abort-on-container-exit
+mvn install -DskipTests=true
 ```
 
 ## Run
 ```
-java -jar target/SET08103-G20-X-X-X-jar-with-dependencies.jar
+java -jar target/SET08103-G20.jar {ip address}
 ```
-where `X-X-X` is the version number
+
+Where {ip address} is the ip address of the SQL server you wish to connect to.
+
+## Features
+
+| ID  | Name | Met | Screenshot |
+|-----|------|-----|------------|
+| 1   | All the countries in the world organised by largest population to smallest. | Yes | [Link](img/1.png) |
+| 2   | All the countries in a continent organised by largest population to smallest. | Yes | [Link](img/2.png) |
+| 3   | All the countries in a region organised by largest population to smallest. | Yes | [Link](img/3.png) |
+| 4   | The top `N` populated countries in the world where `N` is provided by the user. | Yes | [Link](img/4.png) |
+| 5   | The top `N` populated countries in a continent where `N` is provided by the user. | Yes | [Link](img/5.png) |
+| 6   | The top `N` populated countries in a region where `N` is provided by the user. | Yes | [Link](img/6.png) |
+| 7   | All the cities in the world organised by largest population to smallest. | Yes | [Link](img/7.png) |
+| 8   | All the cities in a continent organised by largest population to smallest. | Yes | [Link](img/8.png) |
+| 9   | All the cities in a region organised by largest population to smallest. | Yes | [Link](img/9.png) |
+| 10  | All the cities in a country organised by largest population to smallest. | Yes | [Link](img/10.png) |
+| 11  | All the cities in a district organised by largest population to smallest. | Yes | [Link](img/11.png) |
+| 12  | The top `N` populated cities in the world where `N` is provided by the user. | Yes | [Link](img/12.png) |
+| 13  | The top `N` populated cities in a continent where `N` is provided by the user. | Yes | [Link](img/13.png) |
+| 14  | The top `N` populated cities in a region where `N` is provided by the user. | Yes | [Link](img/14.png) |
+| 15  | The top `N` populated cities in a country where `N` is provided by the user. | Yes | [Link](img/15.png) |
+| 16  | The top `N` populated cities in a district where `N` is provided by the user. | Yes | [Link](img/16.png) |
+| 17  | All the capital cities in the world organised by largest population to smallest. | Yes | [Link](img/17.png) |
+| 18  | All the capital cities in a continent organised by largest population to smallest. | Yes | [Link](img/18.png) |
+| 19  | All the capital cities in a region organised by largest to smallest. | Yes | [Link](img/19.png) |Contribution
+| 20  | The top `N` populated capital cities in the world  where `N` is provided by the user. | Yes | [Link](img/20.png) |
+| 21  | The top `N` populated capital cities in a continent where `N` is provided by the user. | Yes | [Link](img/21.png) |
+| 22  | The top `N` populated capital cities in a region where `N` is provided by the user. | Yes | [Link](img/22.png) |
+| 23  | The population of people, people living in cities, and people not living in cities in each continent. | Yes | [Link](img/23.png) |
+| 24  | The population of people, people living in cities, and people not living in cities in each region. | Yes | [Link](img/24.png) |
+| 25  | The population of people, people living in cities, and people not living in cities in each country. | Yes | [Link](img/25.png) |
+| 26  | The population of the world. | Yes | [Link](img/26.png) |
+| 27  | The population of a continent. | Yes | [Link](img/27.png) |
+| 28  | The population of a region. | Yes | [Link](img/28.png) |
+| 29  | The population of a country. | Yes | [Link](img/29.png) |
+| 30  | The population of a district. | Yes | [Link](img/30.png) |
+| 31  | The population of a city. | Yes | [Link](img/31.png) |
+| 32  | The number of people who speak Chinese, English, Hindi, Spanish or Arabic in the world. | Yes | [Link](img/32.png) |
+
+## Contributions
+
+|                  | #1  | #2  | #3  | #4  | Final | Avg       |
+|------------------|-----|-----|-----|-----|-------|-----------|
+| Johann Leonhardt | 43% | 23% | 35% | 33% | 27%   | **32.2%** |
+| Jacob Barrow     | 20% | 31% | 25% | 22% | 17%   | **23.0%** |
+| Toby Cook        | 15% | 26% | 25% | 20% | 33%   | **23.8%** |
+| Raish Allan      | 22% | 20% | 15% | 25% | 23%   | **21.0%** |
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,2 @@
+ignore:
+    - "src/main/java/com/napier/group20/Main.java"
diff --git a/img/1.png b/img/1.png
diff --git a/img/10.png b/img/10.png
diff --git a/img/11.png b/img/11.png
diff --git a/img/12.png b/img/12.png
diff --git a/img/13.png b/img/13.png
diff --git a/img/14.png b/img/14.png
diff --git a/img/15.png b/img/15.png
diff --git a/img/16.png b/img/16.png
diff --git a/img/17.png b/img/17.png
diff --git a/img/18.png b/img/18.png
diff --git a/img/19.png b/img/19.png
diff --git a/img/2.png b/img/2.png
diff --git a/img/20.png b/img/20.png
diff --git a/img/21.png b/img/21.png
diff --git a/img/22.png b/img/22.png
diff --git a/img/23.png b/img/23.png
diff --git a/img/24.png b/img/24.png
diff --git a/img/25.png b/img/25.png
diff --git a/img/26.png b/img/26.png
diff --git a/img/27.png b/img/27.png
diff --git a/img/28.png b/img/28.png
diff --git a/img/29.png b/img/29.png
diff --git a/img/3.png b/img/3.png
diff --git a/img/30.png b/img/30.png
diff --git a/img/31.png b/img/31.png
diff --git a/img/32.png b/img/32.png
diff --git a/img/4.png b/img/4.png
diff --git a/img/5.png b/img/5.png
diff --git a/img/6.png b/img/6.png
diff --git a/img/7.png b/img/7.png
diff --git a/img/8.png b/img/8.png
diff --git a/img/9.png b/img/9.png