Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.5 KB

README.md

File metadata and controls

44 lines (32 loc) · 1.5 KB
Raw

Code Enforcement Frontend Component

This frontend component allows users to upload files which are then analyzed by a Code Enforcement LLM (Large Language Model) to identify code violations.

Features

  • File Upload: Users can upload files in various formats.
  • Code Analysis: The uploaded files are sent to a backend service where a Code Enforcement LLM analyzes the content for code violations.
  • Violation Reporting: The results of the analysis, including any identified code violations, are displayed to the user in an easy-to-read format.

Usage

  1. Upload a File: Click the "Upload" button and select a file from your computer.
  2. Analyze the File: Once the file is uploaded, it will be automatically sent to the backend for analysis.
  3. View Results: After the analysis is complete, the results will be displayed on the screen, highlighting any code violations found.

Installation

To install and run this component locally, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/your-repo/codeEnspoment.git
  2. Navigate to the project directory: 
    cd codeEnspoment
  3. Install dependencies: 
    npm install
  4. Start the development server: 
    npm run dev

Contributing

We welcome contributions to improve this component. Please fork the repository and submit a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.