Software | Recommended version | Getting Started Guide |
---|---|---|
Node.js (node) | 16.16.0 | Install Node.js |
npm | 8.15.1 | Download and Install npm |
Angular | 15.2.10 | Angular Quick Start Guide |
Software | Recommended version | Getting Started Guide |
---|---|---|
Python | 3.11.5 | Python Getting Started |
PyPDF2 | 3.0.1 | PyPDF2 Documentation |
To use the Backend/API, follow these steps:
- Clone the "Pre_process" repository.
- Run the Python app continuously using the following command:
python Pre_processing.py
To connect the Frontend with the API on your server, follow these steps:
- Locate the
config.json
file. - Specify your publicly available API to communicate with the backend.
To set up a development environment, follow these steps:
- Clone the repository.
- Run the following commands in the terminal:
npm install ng serve
- Navigate to
http://localhost:4200/
. The application will automatically reload if you change any source files.
To build the application, run the following command:
ng build
The built project will be stored in the dist/
directory.
The process of PDF upload and text retrieval is split into two steps for a more responsive application.
-
PDF Upload Process:
- Users can upload one PDF file at a time.
- The backend generates a unique identifier for each uploaded PDF.
- The frontend quickly receives this identifier.
- Uploaded files are saved for the current browser session.
-
Text Retrieval Process:
- Users can access uploaded files via an API call with the unique identifier.
- The backend searches for the file and responds with processed plain text.
- If processing is not finished, the user is informed to retry later.
- Once processing is complete, the backend responds with plain text.
For visual representations of these processes, refer to the following figures: