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
- 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.
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):
You can revoke Meeshkan's access to your repository any time in your GitHub Applications settings.
Although we'd definitely prefer if you contacted us first. We might be able to help!
If you'd like to delete your Meeshkan account, please contact our team.