janvi-thakkar/keploy-ui

UI for Keploy platform that does API testing by dependency mocking without writing any test cases.

Welcome to Keploy UI 👋

About Us

Keploy is a no-code API testing platform.

Keploy automatically generates unit test cases with dependency mocks from API calls

Developers can use keploy alongside their favorite unit testing framework to save time writing testcases.

How it works?

Note: You can generate test cases from any environment which has all the infrastructure dependencies setup. Please consider using this to generate tests from low-traffic environments first. The deduplication feature necessary for high-traffic environments is currently experimental.

Installation

This is the UI repository of Keploy platform. Please follow QuickStar/Installation guide.

Contribution

Make sure you're using Node version 14.16.0

1. Start the Keploy Server

There's a separate docker-compose file which helps which exposes the mongo server and also builds the dockerfile from local code. The build flag ensures that the binary is built again to reflect the latest code changes. There's also docker-compose-debug.yaml which can help remote debugging the go server on port 4000.

git clone https://github.com/keploy/keploy.git && cd keploy
docker-compose -f docker-compose-dev.yaml up --build

2. Start the Keploy Console/UI

git clone https://github.com/keploy/ui.git && cd ui
npm i 

For development, we'll add the API URL as local keploy server url running at http://localhost:8081

export GATSBY_API_URL=http://localhost:8081/api

Now let's start the Gatsby Server

npm run develop

If you make some UI/design changes and want to add test data. In the new directory, clone test data repo :

git clone https://github.com/keploy/test-data.git && cd test-data

Within test-data directory

Install mongo-database-tools

brew tap mongodb/brew
brew install mongodb-database-tools

Restore DB

mongorestore  dump/

You should now be able to see test data on the UI.

Community support

We'd love to collaborate with you to make Keploy great. To get started feel free to reach out to us :

• Slack - Discussions with the community and the team.
• GitHub - For bug reports and feature requests.

📌 Our valuable Contributors👩‍💻👨‍💻 :