Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.67 KB

README.md

File metadata and controls

48 lines (38 loc) · 1.67 KB

AuditX

AuditX is a decentralized platform designed to connect developers and auditors in a transparent and rewarding way. It enables users to submit their repositories for audits, empowers auditors to submit proposals (GitHub PRs), and ensures that the best proposals are fairly rewarded through decentralized voting and verification.

Features

  • For Users (Repo Owners):

    • Submit your repository for auditing and set a reward amount.
    • Vote on proposals submitted by auditors.
    • Finalize audits to distribute rewards among approved auditors.

  • For Auditors:

    • Audit repositories and submit GitHub PR proposals.
    • Gain approval through user votes and verification by the app.
    • Claim your share of the reward after the audit is finalized.

  • Why Choose AuditingX?

    • Transparent process with public voting and verification.
    • Fair and decentralized reward distribution.
    • A streamlined experience for both repo owners and auditors.

How to Run

Prerequisites

  1. Ensure you have Node.js and Bun installed on your system.

Steps to Run the App

  1. Clone the repository: 
    git clone https://github.com/your-repo/auditingx.git
cd frontend
  2. Install dependencies: 
    bun install
  3. Start the development server: 
    bun dev
  4. Access the app in your browser at http://localhost:3000 or your custom port.

Contributing

We welcome contributions to improve the platform. Please see our CONTRIBUTING.md for guidelines on how to submit improvements and bug fixes.

Lets make the defi world a better place together!