Skip to content

README.md

Latest commit

 

History

History
31 lines (22 loc) · 1.25 KB

README.md

File metadata and controls

31 lines (22 loc) · 1.25 KB

Reading Tracker API

This project implements a reading tracker API, allowing a reader to track their progress on the books they are reading.

Technology

  • Java 17
  • Spring Boot
  • Spring Data JPA
  • SQLite
  • JUnit
  • Mockito
  • H2

Goals

This project serves as exploration into using SQLite and JPA to further my Java skills with Spring Boot and the Java persistence layer.

How to Run

If you don't have Maven installed, you will need to install that first. For those having trouble using mvnw with Maven installed, try running the following command from the project directory to setup the Maven jar for the Spring Boot wrapper to use it:

mvn -N io.takari:maven:wrapper

To start, please run a ./mvnw install to install all necessary dependencies before attempting to run the project.

After installation, run ./mvnw spring-boot:run. You can then make requests in a tool like Postman to http://localhost:8080/books*.

Please note, the repository is currently configured to recreate the DB on each run, so changes are not persisted across runs.

Tests

There are tests defined for each layer using JUnit, Mockito, and Spring Boot tests. These are run during the install step, but can also be run manually using ./mvnw test. All tests are passing.