https://github.com/decipher3114/polisharp
An AI-powered tool that simplifies privacy policies by processing URLs or PDFs and providing a concise, tabular summary for quick and easy understanding.
https://github.com/decipher3114/polisharp
Last synced: 10 months ago
JSON representation
An AI-powered tool that simplifies privacy policies by processing URLs or PDFs and providing a concise, tabular summary for quick and easy understanding.
- Host: GitHub
- URL: https://github.com/decipher3114/polisharp
- Owner: decipher3114
- License: mit
- Created: 2024-12-02T05:13:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-02T05:34:03.000Z (about 1 year ago)
- Last Synced: 2024-12-02T06:22:39.144Z (about 1 year ago)
- Language: Svelte
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
```bash
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=`.
OR
- Put the api key in the Gemini API Key field.
- Set up the frontend:
```bash
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`):
```bash
cd backend
uvicorn main:app
```
- **Session 2**: Start the frontend:
```bash
cd frontend
npm run dev
```
Access the app in your browser at http://localhost:5173.
## 📜 License
This project is licensed under the [MIT License](./LICENSE).