Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 2.84 KB

README.md

File metadata and controls

84 lines (50 loc) · 2.84 KB
Raw

Here’s an updated version of the README with detailed local setup Contributions Welcome Slack License

Keploy

Keploy is a no-code testing platform that generates tests from API calls. It allows you to create end-to-end tests without writing a single line of code, making it easier to ensure the reliability of your APIs.

Note: This extension currently supports only Go, Node, Python and Java programming language.

Features

Record and Replay TestCases.

View Previous TestRun Result.

View and Edit Keploy Config File

Installation

  1. Install the Keploy extension from the JetBrains Marketplace.

  2. Keploy CLI is present : - curl --silent -O -L https://keploy.io/install.sh && source install.sh

Contribution Guide

Prerequisites

Before you begin, ensure you have the following installed on your machine:

  • JDK (Java Development Kit): Version 11 or higher.
  • Gradle: The project uses Gradle as its build system.

Cloning the Repository

First, clone the repository to your local machine:

git clone https://github.com/keploy/keploy.git
cd keploy

Building the Project

To build and run the project locally, follow these steps:

  1. Install Dependencies: Ensure all the necessary dependencies are installed.

    ./gradlew clean build

  2. Run the IDE: Start the IntelliJ IDEA instance with the plugin.

    ./gradlew runIde

  3. Packaging the Plugin: To build a distributable version of the plugin:

    ./gradlew buildPlugin

The generated plugin will be available in the build/distributions directory.

  1. From the debug console, you can see the output or errors if any.

Make changes to Frontend

  1. Run npm run rollup to compile your svelte files into js files present in out/compiled dir.

  2. Make changes to your svelte code and the js files will be automatically re-compiled.

Community Support

We'd love to collaborate with you to make Keploy even better. Here’s how you can get involved:

  • Slack: Join our Slack community to discuss and collaborate.
  • GitHub Issues: Report bugs, suggest new features, and track the development progress.

License

Keploy is licensed under the Apache License 2.0. See the LICENSE file for more details.