Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.58 KB

README.md

File metadata and controls

78 lines (56 loc) · 2.58 KB

Official Web Dashboard for Quash

Welcome to the Quash Frontend repository, part of the Quash project. This repository contains the code for the Quash Web Dashboard, your ultimate in-app bug reporting tool. Built by developers for developers, this web dashboard captures everything you need to start fixing issues right away. It displays crash logs, session replays, network logs, device information, and much more, ensuring you have all the details at your fingertips.

Features

  • Session Replays: Watch exactly what happened during the bug.
  • Crash Logs & Network Logs: Detailed technical information for swift debugging.
  • Device Information: Detailed device information including OS version, device model, and more.

Tech Stack

Getting Started

Prerequisites

  • Node.js (version 18 or later)

Installation

  1. Clone the parent repository and move to the frontend directory:

    git clone https://github.com/Oscorp-HQ/quash-max.git
cd quash-max/frontend

  2. Install dependencies: Using npm:

    npm install

    Or using yarn:

    yarn install

  3. Set up environment variables: Create a .env.local file in the frontend directory and add necessary environment variables as shown in .env.example.

Usage

  1. Run the development server: Using npm: 
    npm run dev
    Or using yarn: 
    yarn dev
    Open http://localhost:3000 with your browser to see the result.

Repository Structure

This frontend repository is part of the larger Quash project, located in the parent repository at https://github.com/Oscorp-HQ/quash-max. The parent repository contains multiple components of the Quash project, including this frontend.

For information on other components and how they interact, please refer to the main README in the parent repository.

Contributing

For contribution guidelines, please refer to the CONTRIBUTING.md file in the parent repository.

License

This project is licensed under the terms specified in the LICENSE file in the parent repository.