diff --git a/README.md b/README.md index 6c2e78f2..adea5829 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,68 @@ -

Keploy Java Samples

-

+

πŸš€ Keploy Java Samples

- - - - - - - - +

+ + Contributions Welcome + + + Join Slack + + + License: Apache 2.0 +

-This repo contains the sample for [Keploy's](https://keploy.io) Java Application. Please feel free to contribute if you'd like submit a sample for another use-case or library. +--- + +Welcome to the **Keploy Java Samples** repository! πŸŽ‰ + +This repo showcases sample Java applications integrated with [Keploy](https://keploy.io) β€” an open-source end-to-end testing tool built for developers. + +> ⚠️ **Note:** Issues are disabled here. To raise bugs or feature requests, please visit the main [Keploy issue tracker](https://github.com/keploy/keploy/issues/new/choose). + +--- + +## πŸ“¦ What's Inside? + +Here’s a collection of ready-to-use Java apps to help you get started with Keploy quickly: + +| Sample App | Tech Stack | Description | +|------------|------------|-------------| +| πŸ”— [Employee Manager](https://github.com/keploy/samples-java/tree/main/employee-manager) | Spring Boot, PostgreSQL | Manage employee data and test Keploy integration | +| πŸ”— [SpringBoot MongoDB](https://github.com/keploy/samples-java/tree/main/spring-boot-mongo) | Spring Boot, MongoDB | CRUD app for Magical Potions πŸ§ͺ in Keploy inventory | +| πŸ”— [User Manager](https://github.com/keploy/samples-java/tree/main/user-manager) | Spring Boot, MongoDB | Simple user management system | +| πŸ”— [Postgres GraphQL](https://github.com/keploy/samples-java/tree/main/spring-boot-postgres-graphql) | Spring Boot, GraphQL, PostgreSQL | Book & Author management with GraphQL APIs | +| πŸ”— [Spring PetClinic](https://github.com/keploy/samples-java/tree/main/spring-petclinic) | Spring Boot | Record UI interactions as test cases with Keploy | + +--- -> **Note** :- Issue Creation is disabled on this Repository, please visit [here](https://github.com/keploy/keploy/issues/new/choose) to submit Issue. +## 🀝 How to Contribute? -## Java Sample Apps with Keploy +We welcome contributors of all skill levels! +You can: +- Submit a new sample app πŸ“² +- Improve documentation πŸ“ +- Fix bugs or enhance existing samples πŸ› οΈ -1. [Employee Manager](https://github.com/keploy/samples-java/tree/main/employee-manager) - A sample Employee-Manager app to test Keploy integration capabilities using SpringBoot and PostgreSQL. -2. [Springboot MongoDB](https://github.com/keploy/samples-java/tree/main/spring-boot-mongo) - The application is built purely with Java Spring-Boot that does the complete CRUD in the MongoDB database. This CRUD Application is about managing the data of Magical Potions in the Keploy inventory. -3. [User Manager](https://github.com/keploy/samples-java/tree/main/user-manager) - A sample User-Manager app to test Keploy integration capabilities using SpringBoot and MongoDB. -4. [Springboot Postgres GraphQL](https://github.com/keploy/samples-java/tree/main/spring-boot-postgres-graphql) - This is a Spring Boot application implementing a GraphQL service to handle requests related to books and authors. -5. [Springboot PetClinic](https://github.com/keploy/samples-java/tree/main/spring-petclinic) - This is a Pet Clinic app where you can record testcases and mocks by interacting with the UI, and then test them using Keploy. +Just make sure to read our: +- πŸ“œ [Contribution Guidelines](https://github.com/keploy/keploy/blob/main/CONTRIBUTING.md) +- ❀️ [Code of Conduct](https://github.com/keploy/keploy/blob/main/CODE_OF_CONDUCT.md) -## Community Support ❀️ +--- -### πŸ€” Questions? +## πŸ™‹ Need Help? -Reach out to us. We're here to help! +Join our growing community and get instant support! [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg) -[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/keploy/) +[![LinkedIn](https://img.shields.io/badge/LinkedIn-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/keploy/) [![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)](https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg) [![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/Keployio) -### πŸ’– Let's Build Together! +--- -Whether you're a newbie coder or a wizard πŸ§™β€β™€οΈ, your perspective is golden. Take a peek at our: +> πŸ›  Whether you're just getting started or already building APIs, these samples are designed to help you write better tests faster with Keploy. -πŸ“œ [Contribution Guidelines](https://github.com/keploy/keploy/blob/main/CONTRIBUTING.md) +--- -❀️ [Code of Conduct](https://github.com/keploy/keploy/blob/main/CODE_OF_CONDUCT.md) +### ✨ Let's Build Something Awesome Together!