Skip to content

An AI-powered tool that simplifies privacy policies by processing URLs or PDFs and providing a concise, tabular summary for quick and easy understanding.

License

Notifications You must be signed in to change notification settings

decipher3114/polisharp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

img An AI-powered tool that simplifies complex privacy policies. By providing a URL or uploading a PDF of a privacy policy, users receive a concise, tabular summary, enabling them to understand critical information quickly and easily.

🚀 Features

  • URL & PDF Input: Accepts privacy policies via URL or file upload.
  • AI-Powered Summarization: Processes lengthy and dense policies using advanced AI algorithms.
  • Tabular Output: Presents key points (e.g., data collection, purpose, and criticality) in a user-friendly table.
  • Enhanced Transparency: Helps users make informed decisions regarding their data privacy.

🛠️ Tech Stack

  • Frontend: SvelteKit with TailwindCSS for a modern, responsive user interface.
  • Backend: Python (FastAPI) for processing and AI integration.
  • AI Integration: Utilizes Google Gemini's large language models (LLMs) for natural language processing.

📦 Installation

  • Clone the repository:
git clone https://github.com/decipher3114/polisharp.git
cd polisharp
  • Set up the backend:
    • Setup Virtual Environment
    cd backend
    python3 -m venv venv
    
    • Activate Virtual Environment:
      • For Linux:
      source venv/bin/activate
      
      • For Windows:
      venv/scripts/activate
      
    • Install Requirements
    pip install -r requirements.txt
    
  • Setup Gemini API Key (Critical: One must be satisfied)
    • Create a new file with the name .env in backend dir.
    • Paste the following GEMINI_API_KEY=<your_api_key>.
      OR
    • Put the api key in the Gemini API Key field.
  • Set up the frontend:
cd ../frontend
npm install

🚀 Usage

  • Open TWO terminal sessions and change directory to polisharp.
  • Session 1: Start the backend (available at http://127.0.0.1:8000):
cd backend
uvicorn main:app
  • Session 2: Start the frontend:
cd frontend
npm run dev

Access the app in your browser at http://localhost:5173.

📜 License

This project is licensed under the MIT License.

About

An AI-powered tool that simplifies privacy policies by processing URLs or PDFs and providing a concise, tabular summary for quick and easy understanding.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published