From ab46bb5c979cc26344f2d0b6b6dc8c448e5c3844 Mon Sep 17 00:00:00 2001 From: Commander Bittu Date: Thu, 19 Jun 2025 17:37:20 +0530 Subject: [PATCH] Updated docs: improved Quick Start section --- src/components/QuickStart.js | 131 ++++++++++++++++++++++------------- 1 file changed, 84 insertions(+), 47 deletions(-) diff --git a/src/components/QuickStart.js b/src/components/QuickStart.js index 72543cc63..3fc4cfb2c 100644 --- a/src/components/QuickStart.js +++ b/src/components/QuickStart.js @@ -8,64 +8,59 @@ export const QuickStart = () => {

Welcome to Keploy Documentation! ๐Ÿš€

-

+

This documentation will help you get the most out of Keployโ€”whether - youโ€™re building your first project or leveling up your testing workflow. + you're building your first project or leveling up your testing workflow.

What is Keploy? ๐Ÿค”

-

- Keploy is your open-source, developer-centric backend testing tool. It - makes backend testing easy and productive for engineering teams. Plus, - it's easy-to-use, powerful and extensible..๐Ÿ› ๏ธ Keploy also has AI-powered - tools that help you generate unit and api tests quickly, helping - developers focus on writing code rather than writing tests. +

+ Keploy is your open-source, developer-centric backend testing tool that + makes backend testing easy and productive for engineering teams. It's + user-friendly, powerful, and extensible. ๐Ÿ› ๏ธ Keploy features AI-powered + tools that help you generate unit and API tests quickly, allowing + developers to focus on writing code rather than writing tests.

-

- Keploy creates test cases and data mocks/stubs from user-traffic by - recording API calls and DB queries, significantly speeding up releases +

+ Keploy creates test cases and data mocks/stubs from user traffic by + recording API calls and database queries, significantly speeding up releases and enhancing reliability. ๐Ÿ“ˆ

- {/*

*/} - {/* Contribute through Hacktoberfest โœ…*/} - {/*

*/} - {/*

*/} - {/* DigitalOcean's Hacktoberfest is a month-long celebration of open-source*/} - {/* contributions. Everyone is welcome to participate, regardless of their*/} - {/* experience level. Simply make a pull request to an open-source project*/} - {/* to get started.*/} - {/*

*/} - {/* You can contribute to{" "}*/} - {/* */} - {/* several Keploy projects*/} - {/* {" "}*/} - {/* participating this year, If youโ€™ve ever wanted to contribute to open*/} - {/* source , now is your chance!*/} - {/*

*/} - {/* Anyone around the globe who desires to help drive the growth of open*/} - {/* source and make positive contributions to an ever-growing community. All*/} - {/* backgrounds and skill levels are encouraged to participate.{" "}*/} - {/* */} - {/* Learn How to Contribute?*/} - {/* */} - {/*

*/} +

+ Key Features โœจ +

+
+
+

๐Ÿค– AI-Powered Testing

+

Generate comprehensive unit and API tests automatically

+
+
+

๐Ÿ“Š Traffic Recording

+

Capture real API calls and database queries

+
+
+

๐Ÿ”ง Developer-Friendly

+

Easy integration with existing workflows

+
+

Installation Guide ๐Ÿ“—

-

- Let's get Keploy up and running on your Windows, Linux, or macOS - machine, so you can start crafting test cases in minutes. โฑ๏ธ +

+ Get Keploy up and running on your Windows, Linux, or macOS + machine in minutes. Choose your operating system below: โฑ๏ธ

{ alt="Windows logo" />

Windows

+

Windows 10/11 supported

{ alt="Linux logo" />

Linux

+

Best experience available

Mac logo -

MacOS

+

macOS

+

Intel & Apple Silicon

+ +
+ +
+

+ โš ๏ธ Note: Keploy v2 is currently in development, with the best + experience on Linux. Docker support is experimental and may have some + limitations for certain use cases. +

+
+ +

+ Quick Links ๐Ÿ”— +

+
+ +

๐Ÿ“š Core Concepts

+

Learn the fundamentals

+ + +

๐Ÿš€ Quick Start

+

Get up and running

+ + +

๐ŸŽฏ Tutorials

+

Step-by-step guides

+ + +

๐Ÿ”ง API Reference

+

Technical documentation

-

- โš ๏ธ Please note that Keploy v2 is currently in development, with the best - experience on Linux. Docker support is experimental and may have some - limitations for certain use cases. -

); -}; +}; \ No newline at end of file