Skip to content
This repository has been archived by the owner on Nov 20, 2021. It is now read-only.

Latest commit

 

History

History
36 lines (28 loc) · 2.41 KB

readme.md

File metadata and controls

36 lines (28 loc) · 2.41 KB

Movie Notifier

License Docker

Movie Notifier monitors local cinema's and notifies users when new shows are available. Users can register and configure their notification settings. Registered users can create watchers with a number of filters to be notified of new showings in their aria. Using this application gives users the opportunity to always have the best seats for every show!

This repository contains the backend system of the Movie Notifier system. This backend is accessible via a HTTP API. The full specification of this API can be found in the swagger.yaml file in the root of this repository. A frontend android app implementation can be found in this repository

Deployment

Whatever way of deployment is chosen, a movie-notifier.properties file is required. This file contains all settings that the movie-notifier application requires. This file has the following structure:

# Connection string for the mongo database as described here:
# https://docs.mongodb.com/manual/reference/connection-string/
# This property is required.
spring.data.mongodb.uri=

# Settings for mail notifications using the Rollbar mailing api.
mailgun.domnain=
mailgun.apikey=
mailgun.from.mail=
mailgun.from.name=

# The api key of the Pathe Cinema Api
cinema.pathe.apikey=

# The path to a google cloud api json keyfile that gives access to firebase cloud messaging sending services.
fcm.serviceaccountkeyfile=

Copy the above example and fill in the required properties. Movie-notifier uses Spring Boot which means that that there are many more options that can be configured in this file. These properties are described here

Formatting

The Cosium/maven-git-code-format plugin is configured to automatically run the google-java-format formatter as a pre-commit git hook. On commit, the hook will automatically format staged java files. To manually format all java code run mvn git-code-format:format-code