= README

== ABOUT ROBOT PROJECT

image:https://jenkins-nasz-pan.pl/buildStatus/icon?job=test_pipeline_1%2Fmaster[Build Status] image:https://jenkins-nasz-pan.pl/sonar/api/project_badges/measure?project=edition.academy.seventh%3Arobot&metric=alert_status[Quality Gate Status]

Robot collects information about books on promotion and those available for free in various libraries. Some through their REST APIs, some through screen-scraping. Information is persisted in the database and there is a simple reporting module.

== PREREQUISITES

IMPORTANT: Before coding you have to (by using command line) go into a git-hooks directory, use a command chmod +x add-hooks and next run ./add-hooks to activate the git hooks. They will prevent git commits that not building project.

=== System requirements

• Ubuntu 18.04,
• Java 11.0.4 OpenJDK,
• Maven 3.3.9,
• Internet connection.

=== Others

Clone this repository to your desired directory.

Prerequisites for running tests are described in <<anchor-1, RUNNING#Tests>> section. Prerequisites for running backend application are described in <<anchor-2, RUNNING#Application>> section.

== RUNNING

=== Tests

[[anchor-1]]To run integration or full scope of tests you need to:

• have active connection H2 database on port 9092 with name test and credentials defined as one in H2Connector.java in package edition.academy.seventh.connector, or
• change protocol defined in H2Connector.java (javax.persistence.jdbc.url, line: 18) used by H2 database from tcp to mem.

==== Full scope of tests

Go into a main project's directory using command line and use mvn clean verify command to run unit, integration and performance tests.

==== Integration tests

Go into a main project's directory using command line and use mvn clean test-compile failsafe:integration-test command to only integration tests.

==== Performance test

Go into a main project's directory using command line and use mvn clean gatling:test command to run only performance test. Test is performed by open source tool Gatling. This test is part of integration tests scope by default.

==== Unit tests:

Go into a main project's directory using command line and use mvn clean test command to run only unit tests.

=== Application

==== Backend

[[anchor-2]]To run backend part of application you need to have unused port 8080. If it is not a case you have to uncomment line: 1 in application.properties. Then application will start at pot 8085.

To start application use in command line (main project directory):

• mvn clean install -Dmaven.test.skip=true -Dgatling.skip=true and then java -jar target/robot-0.1.jar commands, or
• mvn spring-boot:run command.

==== Frontend

To run frontend part of application read this https://github.com/marcinogo/robot-front/blob/master/README.md[robot-front README].

== USAGE

=== Live version

Application is deployed with frontend part on https://bookrobot-front.herokuapp.com/home[*Heroku* server]. An unauthorized user can view information about books with the latest promotion from various bookstore, sort books, filter them by a bookstore and go to next/previous pages.

The user can also sign in or sign up to perform additional actions:

• An admin can start collecting information about promotions manually to update data,
• A user can perform the same action the unauthorized user and check details about promotions history.

//// === Local version TODO: dodać informaje jak lokalnie tstować apkę, pod jakie endpointy uderzać ////