Skip to content
This repository has been archived by the owner on Aug 19, 2021. It is now read-only.

meeshkan/webapp

Repository files navigation

Meeshkan Webapp

You can sign up for Meeshkan at https://app.meeshkan.com/.

Repositories in, bug fixes out. Meeshkan is an automated testing tool designed to find bugs in your projects. In its current state, it's built to handle APIs and third-party services. Once installed, Meeshkan runs weekly and submits issues to your repository when it finds bugs.

We're actively building this webapp to facilitate the core service. Through the Meeshkan webapp, you can see what tests were run and resolve any issues that come up while executing your tests.

📖 Looking for an overview? Read our announcement blog post.

Example of the Meeshkan dashboard in dark mode.

What's in this document:

Documentation

If you're an existing Meeshkan user, everything from configuration instructions to frequently asked questions is available in the Meeshkan documentation.

Important dependencies

This repository makes heavy use of certain libraries. Without being familiar with the basics of how these libraries work, it will be difficult to understand the code base.

These libraries are, in no particular order:

  • next.js: Opinionated framework for writing server-rendered React apps.
  • chakra-ui: Accessible React component library.
  • fp-ts: Typed functional programming for TypeScript.
  • io-ts: Run-time type system for IO decoding/encoding.
  • monocle-ts: Functional optics for TypeScript projects.

Routing style

We optimize for user experience (clear URL structure) and only add an abstraction if absolutely necessary. The repercussion of this is we will have some reserved paths such as settings, user, and more. We percieve this to have minimal impact and aren't actively solving for these edge cases.

Known issues

  • We currently have no way to know if a user revokes an incoming webhook.
  • GitHub often responds that a stored refresh token is invalid.

Roadmap

We're still in the early stages and things are changing rapidly, but here are some larger goals we'd like to accomplish with this webapp. Please note that these are subject to change at any time.

  • Allow you to control the frequency of your tests
  • Give you access to explore the specification Meeshkan builds of your repository
  • More team-related functionalities
  • Burn-down chart of bugs

Have a suggestion? File an issue.

Contributing

⚠️ The purpose of this repository is to keep our work open and transparent. But, given the way our webapp is configured, we're unable to take outside contributions directly. File an issue if you have a feature request or bug report. You can also contact our team directly.

Please note that this project is governed by the Meeshkan Community Code of Conduct. By participating, you agree to abide by its terms.

➡️ If you're a member of the Meeshkan organization, you can find all of the local development instructions in the contributing guide.