diff --git a/README.md b/README.md index 3afce33..49e7783 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ # calculator-project2 -sample springboot service + +## Intro + +A sample springboot application, including both a service, and an api client. + +## Compile +``` +mvn compiler:compile +``` + +## Test +This will run the basic test set for both the service, and for the API client + +``` +mvn test +``` + +## Run The Service +``` +mvn spring-boot:run +``` + +## Usage + +Once the service is running, you can use the included CalculatorApp to demo the service and +the API client, or you can use something like Insomnia to execute manual queries of the endpoints. + +Command line execution: + +``` +java -classpath + \ {/path/to/your/target/classes:/path/to/your/.m2/repository/dependencies} + \ com.gmgauthier.CalculatorApp +``` + +It might be easier to execute it using an IDE like Eclipse or Intellij + +![](doc/calcapp.png) + +![](doc/insomnia-view.png) + diff --git a/doc/calcapp.png b/doc/calcapp.png new file mode 100644 index 0000000..38fed4f Binary files /dev/null and b/doc/calcapp.png differ diff --git a/doc/insomnia-view.png b/doc/insomnia-view.png new file mode 100644 index 0000000..1ec515c Binary files /dev/null and b/doc/insomnia-view.png differ diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 1798604..87cda94 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -10,4 +10,4 @@ spring.h2.console.path=/h2-console spring.main.banner-mode=off logging.level.org.springframework=OFF -logging.level.root=OFF +logging.level.root=info