Welcome to Quash! We're excited to introduce our next-generation mobile development tool - Quash Max, designed to revolutionize the way you test and debug your applications. With Quash Max, identifying and resolving bugs is as easy as a shake of your device. Our intuitive platform auto-captures session replays, crash logs, and more, allowing you to focus on building new features while we handle the bugs.
We're currently working on a redesign of the application, including a revamp of the codebase, so Documenso can be more intuitive to use and robust to develop upon.
- Check out the first source code release in this repository and test it.
- Join the Discord server for any questions and getting to know to other community members.
- ⭐ the repository to help us raise awareness.
- Spread the word on Twitter that Quash is working towards a more open In-App bug reporting tool.
- Fix or create issues, that are needed for the first production release.
Quash Max is an SDK-enabled bug reporting solution for mobile apps that helps users report bugs efficiently with just a simple shake of their device. The bugs are tracked on a web dashboard with auto-captured context and logs. Quash Max helps you resolve the bugs faster, ensuring your mobile apps are released on time with the highest quality standards. With the ecosystem, teams can optimize the time and resources spent on the testing process, making mobile testing smooth and straightforward.
- Quick Integration: Integrate the Quash Max SDK with your application in less than 5 minutes.
- Detailed Guides: Follow our comprehensive guides for seamless setup.
- Shake to Report: Simply shake your device to launch the reporting window, prefilled with essential information.
- Intuitive Interface: Log bugs in seconds with our user-friendly interface.
- Real-Time Capture: Automatically detect and capture crash events along with all necessary information.
- Reproduce-Free Debugging: No need to reproduce crashes manually.
- Comprehensive Data Collection: Auto-capture screenshots, session recordings, crash logs, steps to reproduce, device information, and API/network calls.
- Detailed Bug Reports: Each bug report includes all relevant data at the moment of the crash or when shaking the device.
- Enhanced Reports: Add audio recordings, pictures, videos, and other media files to bug reports.
- Web Dashboard: Manage all reported bugs and crashes through the Quash web dashboard.
- Collaboration Tools: View, track, prioritize, and comment on bugs for efficient resolution.
- Popular Tools: Integrate with Jira, Slack, Google Sheets, Linear, GitHub, and more.
- Streamlined Workflow: Export tickets directly to these platforms for a seamless bug tracking and resolution process.
-
Shake Device: Trigger the bug report by shaking your device.
-
Fill Report: Use the prefilled bug report window to add any additional details.
-
Submit: Submit the report, which is then captured and sent to the Quash web dashboard.
- Dashboard Access: Log in to the Quash web dashboard.
- View Reports: Access detailed bug reports with all captured data.
Quash Max comprises three main components: the SDK, the backend, and the frontend.
- Android SDK: The Quash Max SDK for Android provides in-app bug reporting and crash detection.
- Integration: Simple integration with your application, including network interception and configuration.
- Spring Boot Application: Handles API requests, processes bug reports, and manages integrations with third-party tools.
- Scalable Infrastructure: Built to handle high volumes of data and concurrent users.
- Next.js Dashboard: A user-friendly web interface for viewing and managing bug reports.
- Real-Time Data: Displays real-time data captured by the SDK, with options for collaboration and issue tracking.
We love contributions! Please read our contribution guide to get started. We welcome all kinds of contributions, from code enhancements to documentation improvements.
-
Fork the repository to your own Github account.
-
Move to your workspace:
cd your-workspace -
After forking the repository, clone it to your local device by using the following command:
git clone https://github.com/Oscorp-HQ/quash-max.git
-
Move to the directory of your choice and start making changes:
# For backend cd quash-max/backend # For frontend cd quash-max/frontend # For sdk cd quash-max/android
For detailed steps for running different components, refer to their respective guides:
Frontend and SDK have a dependency on Backend to view the data and changes that you make. So please have a running backend before proceeding to run frontend or sdk. You can run max backend by either running the code manually or using a pre-built docker image. Follow the Backend Setup for detailed steps.
For detailed SDK instructions, please refer to the individual android README file.
For backend setup and deployment instructions, please refer to the backend README file.
For frontend setup and deployment instructions, please refer to the frontend README file.
Note: For deploying SDK, refer to the deplyment section of android - SDK Installation Guide
For a detailed, step-by-step guide on setting up Quash Max's Frontend and Backend using Docker, whether on your local machine or a hosted VM instance, please refer to our Quick Start Guide.
Quash is licensed under the MIT License.
For any questions or support, please reach out to us at [email protected].
Thank you for choosing Quash! We look forward to helping you streamline your mobile app testing and bug reporting processes. Let's build something amazing together!