Skip to content

Latest commit

 

History

History
141 lines (105 loc) · 3.36 KB

README.md

File metadata and controls

141 lines (105 loc) · 3.36 KB
Raw

🔍 FactChecker

A powerful browser-based fact-checking tool that helps users verify information in real-time.

🌟 Features

  • Real-time Fact Checking: Analyze statements directly from web pages
  • Browser Extension: Seamless integration with your browsing experience
  • AI-Powered Analysis: Utilizes advanced NLP for accurate fact verification
  • User-Friendly Interface: Clean, modern Next.js frontend
  • Privacy-Focused: Local processing capabilities using Ollama

🏗️ Architecture

The project consists of three main components:

1. Browser Extension (./client)

  • Chrome/Firefox compatible extension
  • Real-time content analysis
  • Sentence tokenization
  • OAuth authentication

2. Backend Server (./server)

  • Fast and efficient fact-checking server
  • DuckDuckGo integration for web searches
  • Ollama integration for AI processing
  • RESTful API endpoints

3. Frontend Application (./frontend)

  • Modern Next.js application
  • Responsive UI with Tailwind CSS
  • Real-time results display
  • Interactive fact-checking interface

🚀 Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • Python 3.8+
  • Ollama installed locally

Installation

  1. Clone the repository
git clone https://github.com/yourusername/FactChecker.git
cd FactChecker
  1. Install backend dependencies
pip install -r requirements.txt
  1. Install frontend dependencies
cd frontend/fact-checker-app
npm install
npm install lucide-react
  1. Install browser extension dependencies
cd ../../client
npm install

🔧 Configuration

  1. Set up your environment variables
  2. Configure the Ollama model settings
  3. Set up DuckDuckGo API credentials (if required)

🖥️ Usage

Running the Server

cd server
python "duckduckgo ollama server.py"
python fact_check_server.py

Starting the Frontend

cd frontend/fact-checker-app
npm run dev

Loading the Browser Extension

  1. Open your browser's extension management page
  2. Enable developer mode
  3. Load unpacked extension from the client directory

📚 API Documentation

The server exposes the following endpoints:

  • POST /check-fact: Submit a statement for fact-checking
  • GET /results: Retrieve fact-checking results
  • POST /feedback: Submit user feedback

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

👥 Authors

🙏 Acknowledgments

  • Thanks to the Ollama team for their amazing AI models
  • The Next.js team for their fantastic framework
  • All contributors and supporters of this project

old readme in case i missed some things here

download and install ollama ollama pull mistral pip install requirements.txt (which we will totally have soon) install npm npm install lucide-react probably some other things

need to start multiple services IMPORTANT: RUN THESE IN ORDER python duckduckgo ollama server.py python fact_check_server.py npm run dev in fact-checker-app 😛