Docucrunch (Document Summariser Application)

Project overview

DocuCrunch is a web app that enables users to upload PDF documents or paste raw text in order to receive a summarised version.

The app leverages two AI models:

• A121: used for summarising articles
• Hugging Face model : used for summarising meeting minutes

Project structure

Front-end(React)

• Handles user interaction, PDF upload, and displays summarised text.

Back-end(Spring/Python)

• Provides REST API endpoints for text extraction and summarisation.
• Makes API calls to the AI models (A121 and Hugging Face)

Setup instructions

Requirements

• Node.js
• Java11+
• Maven

Front-end setup

1. Clone the repository: https://github.com/Selamkd/docuCrunch.git
2. Change directory to docucrunch-front-end: cd front-end/docucrunch-front-end
3. Run the application: npm run dev

Back-end setup

1. Change directory to DocuCrunchBackEnd: cd back-end/DocuCrunchBackEnd
2. Build the project: mvn clean install
3. Run the application: mvn spring-boot:run

API Endpoints

1. Summarise text
   • Endpoint: /api/summarise
   • Method: POST
   • Content-Type: application/json

Takes user input and returns the summarised content

CORS Configuration

The application uses a predefined CORS configuration to allow requests from the front-end. You can adjust the allowed origins (e.g., localhost addresses) in the configuration file.

• File: src/main/java/com/sparta/docucrunchbackend/config/CorsConfig.java

AI Models Configuration

The models are configured in the service layer and can be adjusted according to the specific use case. The models require authentication tokens, which are stored in the application.properties file. Users must provide their own tokens by updating the relevant properties in this file before running the application.

📫 If you come across any bugs, please don't hesitate to open an issue to inform us. Additionally, we appreciate any suggestions for updates or improvements you may have!