README.md

Spyfall Rest API

This is a Rest-API for Spyfall game, inspired by Spyfall card board game.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Things you need to install before running:

Java 8
Gradle
Docker

Running the tests

Run tests with gradle : gradle test

Deployment

To build a jar file:

gradle clean build bootJar

To deploy a whole system use docker-compose:

docker-compose -f docker-compose.yml up

Built With

• Spring – Main framework used to build app
• Gradle – Dependency Management
• MongoDB – Database
• Docker – used to provide an easy way to deploy
• JWT Token – used to authenticate users
• OAuth2 – custom authorization server

Authors

• Kamil Kaliś – kamkali
• Piotr Kuglin – lothar1998

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Docs

Swagger docs