docs: updated documentation to segregate sections for docker and binary #66
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
nehagup
requested changes
Feb 6, 2024
spring-petclinic/README.md
Outdated
|
|
||
| ### For docker on Linux | ||
|
|
||
| keploy test -c "java -jar target/<name-of-your-jar>" --delay 10 |
There was a problem hiding this comment.
isn't the name of the jar fixed since we know the application and we can give the command to make a jar with xyzzy name?
| @@ -64,41 +72,27 @@ to | |||
| spring.datasource.url=jdbc:postgresql://localhost:5432/petclinic | |||
| ``` | |||
|
|
|||
| ## Run the backend with Keploy(binary) | |||
| ## Recording the testcases with Keploy | |||
|
|
|||
| ``` | |||
| keploy record -c "java -jar target/<name-of-your-jar>" | |||
There was a problem hiding this comment.
Specify the jar name since the application is definite
| @@ -3,12 +3,18 @@ | |||
| This is a petclinic app where you can record testcases and mocks by interacting with the UI, and then test them using Keploy. | |||
| This project has two parts - the frontend and backend, since Keploy is a backend testing platform, we need to start the backend part of the project | |||
| using Keploy and run the frontend as it is. | |||
| You can start the backend using Keploy in 2 ways: | |||
| - Using Keploy's binary. | |||
There was a problem hiding this comment.
These should be the hyperlink to the subsequent section
| 3. MVN version 3.6.3 | ||
|
|
||
| Prerequisites For Docker: |
There was a problem hiding this comment.
Better to mention the pre-requisites in their own section tops
|
|
||
| ``` | ||
| # Instructions For Starting Using Docker |
There was a problem hiding this comment.
There's no keploy setup here! User will be lost.
Either move keploy setup to common setup or mention in both sections.
|
@PranshuSrivastava merging this for now as I need this for a demo, please make the changes and open a new PR. |
Signed-off-by: Neha Gupta <gneha21@yahoo.in>
nehagup
approved these changes
Feb 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
Updated the README to make the instructions clearer and segregate the sections for binary and docker.
Fixes #1416
Type of change
Please delete options that are not relevant.
Checklist: