add proper readme doc for project
This commit is contained in:
parent
3ca21fdca9
commit
98a71cf3c3
42
README.md
42
README.md
@ -1,2 +1,42 @@
|
|||||||
# calculator-project2
|
# 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)
|
||||||
|
|
||||||
|
BIN
doc/calcapp.png
Normal file
BIN
doc/calcapp.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 176 KiB |
BIN
doc/insomnia-view.png
Normal file
BIN
doc/insomnia-view.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 66 KiB |
@ -10,4 +10,4 @@ spring.h2.console.path=/h2-console
|
|||||||
|
|
||||||
spring.main.banner-mode=off
|
spring.main.banner-mode=off
|
||||||
logging.level.org.springframework=OFF
|
logging.level.org.springframework=OFF
|
||||||
logging.level.root=OFF
|
logging.level.root=info
|
||||||
|
Loading…
Reference in New Issue
Block a user