Welcome 👋 We're stoked that you're an early adopter and trying out Meeshkan. This documentation is here to help guide you through our core concepts and understand what you can expect.
If you have any questions, you can always contact us for support.
In this section:
- What does Meeshkan do?
- Creating your Meeshkan account
- Authorizing Meeshkan on GitHub
- Configuring your projects
- How Meeshkan reports bugs
- Revoking access
- Deleting your account
Meeshkan is an automated testing and mocking tool. We offer first-class support for GraphQL APIs, but Meeshkan is also built to handle REST APIs and third-party dependencies.
Once installed, Meeshkan runs weekly and submits issues to your repository when it finds bugs.
Almost everything regarding your Meeshkan account (configuration settings, test reports, etc.) will be handled in the Meeshkan webapp.
The following link will take you to the webapp's homepage:Create your free account
It should look similar to this:
To run the tests, Meeshkan must gain permission to access your repository code. To do this, we use a Github App. That's why you're asked to continue with GitHub in the authorization flow when you sign up for Meeshkan.
Here's what that'll look like if you substitute
Unmock for your organization name:
After this, you'll land on the webapp homepage 🎉
For more detailed information about the permissions we require, please read our Required permissions page.
Each project has configuration settings that will allow Meeshkan tests to run automatically. If you'd like tests to run on every commit, please enter your build settings!
You can find your project's configuration at
Please add credentials for your local server, and not your live endpoints. Testing against production credentials can cause permanent data damage.
- Root directory: The path to your app in your repository. For instance, if your app lives in the home directory, then you would use `./` as your root directory.
- Build command: The command(s) your app framework provides for compiling your code.
npm install && npm startis an example build command for a repository that uses NPM and provides a "start" script.
- OpenAPI location: The path or endpoint to your repository's OpenAPI specification (such as
- GraphQL endpoint: The path or endpoint to your repository's GraphQL schema (such as
In several cases, you might want to 'dockerize' your project and provide your
docker-compose up command (or equivalent) as the Meeshkan build command. Here is a list of a few resources that may be useful in the 'dockerization' process:
Meeshkan runs property-based tests on your repository and reports any bugs discovered in the process.
If no bugs were found, you won't hear anything.
When Meeshkan finds a bug, your Meeshkan testing branch check will link to the test in question. This issue will outline which command found the bug, the response, and, in some cases, a suggestion for how to resolve it.
Here's an example issue filed by the Meeshkan GitHub bot (anonymized for privacy):
If you'd like to delete your Meeshkan account, please contact our team.