This project is a PDF Quality Assurance application designed to streamline the process of validating and testing PDF documents.
The project is divided into two main parts: backend and frontend.
The backend is built using Python and includes the following components:
- app: Contains the main application logic, including configuration, database interactions, models, schemas, services, and API endpoints.
- prisma: Contains the Prisma schema for database management.
- uploads: Directory for storing uploaded files.
- requirements.txt: Lists the Python dependencies required for the backend.
- .env: Environment variables for configuration.
The frontend is built using JavaScript and includes:
- public: Static files for the frontend application.
- src: Contains the main source code, including components, pages, and services.
- package.json: Lists the JavaScript dependencies required for the frontend.
- .env: Environment variables for frontend configuration.
To get started with the project, clone the repository and install the necessary dependencies for both the backend and frontend.
- Navigate to the
backenddirectory. - Install the required Python packages using
pip install -r requirements.txt. - Set up your environment variables in the
.envfile. - Run the application using
python -m app.main.
- Navigate to the
frontenddirectory. - Install the required JavaScript packages using
npm install. - Start the frontend application using
npm start.
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
This project is licensed under the MIT License.