legal-doc-masker/frontend/README.md

1.1 KiB

Legal Document Masker Frontend

This is the frontend application for the Legal Document Masker service. It provides a user interface for uploading legal documents, monitoring their processing status, and downloading the masked versions.

Features

  • Drag and drop file upload
  • Real-time status updates
  • File list with processing status
  • Multi-file selection and download
  • Modern Material-UI interface

Prerequisites

  • Node.js (v14 or higher)
  • npm (v6 or higher)

Installation

  1. Install dependencies:
npm install
  1. Start the development server:
npm start

The application will be available at http://localhost:3000

Development

The frontend is built with:

  • React 18
  • TypeScript
  • Material-UI
  • React Query for data fetching
  • React Dropzone for file uploads

Building for Production

To create a production build:

npm run build

The build artifacts will be stored in the build/ directory.

Environment Variables

The following environment variables can be configured: