Skip to content

LibCompanion/CompanionAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CompanionAPI

RESTful Web Service that manages the data library for CompanionMR.

Dependencies

  • Gradle (included)
  • Java 8

Usage

If you have Gradle installed simply execute the gradle task 'bootRun' to start the Web Service:

gradle bootRun

If you do not have Gradle installed you can simply use the gradlew script:

// Windows
gradlew.bat bootRun

// Unix
./gradlew bootRun

Proper API documentation is accessible via Swagger UI: http://localhost:8080/swagger-ui.html

License

CompanionAPI is an RESTful Web Service that manages the data library for CompanionMR.
Copyright (C) 2018 Andreas Sekulski, Dimitri Kotlovsky

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Media File Licenses

Audio "audio0.ogg":
Copyright © Institut für Internet-Sicherheit | if(is). All rights reserved.
Source: https://podcast.internet-sicherheit.de/?podcast=folge-null-vom-cybaercast-dem-it-security-podcast

Image "artist0.jpg":
Copyright © David Bothe 2015. All rights reserved.

Image "art0.jpg":
Copyright © David Bothe 2016
License: CC BY-ND 4.0 (https://creativecommons.org/licenses/by-nd/4.0/)
Source: https://www.internet-sicherheit.de/downloads/infografiken/sicheres-passwort-hashing/

Image "art1.jpg":
Copyright © David Bothe, Sebastian Wacowski 2017
License: CC BY-ND 4.0 (https://creativecommons.org/licenses/by-nd/4.0/)
Source: https://www.internet-sicherheit.de/downloads/infografiken/authentifikationsverfahren/

Images "artist2.jpg", "art2.jpg", "art3.jpg" are public domain.
Sources:
https://commons.wikimedia.org/wiki/File:Neugotische_Kirche_von_Kylemore_Abbey.jpg
https://commons.wikimedia.org/wiki/File:Jacques-Louis_David_-_The_Emperor_Napoleon_in_His_Study_at_the_Tuileries_-_Google_Art_Project.jpg
https://commons.wikimedia.org/wiki/File:David_Self_Portrait.jpg

Video "video0.mp4" and image "video0.jpg":
Copyright © Institut für Internet-Sicherheit | if(is) 2016. All rights reserved.
Source: https://www.youtube.com/watch?v=7qdp9jN8P4w
Music by audionautix.com, licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/)