Escruta - App

Frontend application for the Escruta research platform. It provides a web interface for source management, notebook organization, and AI-assisted document analysis.

Built with React, TypeScript, Tailwind CSS, and Vite.

Important

This application is part of the Escruta ecosystem and requires the core service to be running for full functionality. The project is under development and may contain incomplete features or breaking changes.

Getting Started

Prerequisites

• Node.js (version 20 or higher)
• Escruta Core running (see core README)

Installation

1. npm install - Install dependencies
2. npm run dev - Start the development server

The application will be available at localhost:5173 by default.

Development Scripts

• npm run dev - Start development server with hot reload
• npm run build - Create production build
• npm run lint - Run Biome for code quality checks
• npm run lint:fix - Run Biome for code quality checks and fix issues
• npm run format - Run Biome for code formatting
• npm run format:fix - Run Biome for code formatting and fix issues
• npm run preview - Preview production build locally

Configuration

Environment Variables

Create a .env file in the app root directory:

VITE_ESCRUTA_CORE_URL=http://localhost:8080

Available environment variables:

• VITE_ESCRUTA_CORE_URL: Core API URL (defaults to http://localhost:8080)

Integration with Core

The app communicates with the Escruta core through RESTful APIs. Ensure the backend service is running and accessible at the configured VITE_ESCRUTA_CORE_URL for full functionality.