yusuf7861/askmydoc repository overview

⁠AskMyDoc — Repository Overview (For Users)

AskMyDoc is an AI-assisted document query and knowledge assistant. It allows users to upload documents (PDFs, text files, etc.) and ask questions about them. The system analyzes the content and provides clear, helpful answers.

⁠What This Project Does

• Upload a document
• Ask any question about the document
• Get instant AI-generated answers
• Avoid manually searching through long pages
• Works with study notes, manuals, reports, PDFs, and more

⁠Key Features

• AI-powered question answering
• Fast and accurate responses
• Simple backend API
• Can be integrated with any frontend
• Secure (API key protected)

⁠How It Works (Simple Explanation)

1. You upload a document.
2. The server extracts and processes the text.
3. You ask a question.
4. AI analyzes both the question and the document.
5. You receive a clear, relevant answer.

⁠How the Application Is Deployed

Every time a new version is pushed to the repository:

• The project is built and tested
• A runnable version of the application is created
• A Docker image is published to Docker Hub

This ensures users always receive the latest, stable, and fully tested version.

⁠How Users Can Run the Application

Run the app using Docker:

docker pull yusuf7861/askmydoc:latest
docker run -p 8080:8080 yusuf7861/askmydoc:latest

After running, the backend will be accessible at:

http://localhost:8080

⁠Ideal For

• Students
• Working professionals
• Anyone who reviews documents regularly
• Users who want an automated document assistant

⁠Project Status

This project is actively being improved with:

• Automated testing
• Automated builds
• Docker-based deployment
• Continuous integration (CI)