Retropolis-BE

The back end of the Retropolis application. This is the final project for the apprentices Mar-May-2020. The project is a remote tool to facilitate remote retrospectives.

Teck Stack

The project is build with Spring and Java 11. It uses JUnit and REST Assured for testing. The project follows the Google Java Style Guide.

For continuous integration it uses CircleCI and for the deployment AWS Elastic Beanstalk.

Run it locally

Clone the project on your local machine.
$ git clone https://github.com/codurance/Retropolis-BE.git
Navigate to the project folder and install the dependencies with the following command.
$ mvn install
Set the enviroment variables for the db connection.
- URL, the datasource url of your db (e.g. jdbc:postgresql://localhost:5432/postgres
- USER, the user of your db
- PASS, the password of your db
Run the application locally (the application can be accessed from localhost:5000)
$ mvn spring-boot:run -Dspring.profiles.active=dev

Run tests

You can run the tests by using $ mvn test.

Generate coverage report

You can produce code coverage report using the jacoco plugin $ mvn jacoco:report.

Documentation