Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated petclinic README #67

Merged
merged 6 commits into from
Feb 13, 2024
Merged

docs: Updated petclinic README #67

merged 6 commits into from
Feb 13, 2024

Conversation

PranshuSrivastava
Copy link
Contributor

Pull Request Template

Description

Updated README according to the requested changes

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
@@ -32,21 +20,29 @@ npm i
```
npm run start
```

# Instructions For Starting Using Binary

## Spin up the database
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to mention that user need to cd to rest app.

- [Using Keploy's binary](#binary-guide)
- [Using Keploy's docker image](#docker-guide)

But first, you need to install Keploy. For that you can use the command below:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No one reads "but first" move the keploy instructions above 2 ways.

1. Node 20.11.0 LTS
2. OpenJDK 17.0.9
3. MVN version 3.6.3

## Setup the backend

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cd samples-java/spring-petclinic/spring-petclinic-rest would be required in both docker and bin case, move it to common.

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
@nehagup nehagup merged commit 8d0a976 into main Feb 13, 2024
2 checks passed
jaiakash pushed a commit to jaiakash/samples-java that referenced this pull request Jul 24, 2024
* updated petclinic README

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

* docs: updated Petclinic README

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

* docs: made changes according to comments

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

* docs: removed redundant section

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

* docs: added \n

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

* docs: made changes according to the comments

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

---------

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>
Signed-off-by: Akash Jaiswal <akashjaiswal3846@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants