Skip to content

Latest commit

 

History

History
248 lines (196 loc) · 14.4 KB

README.md

File metadata and controls

248 lines (196 loc) · 14.4 KB

Cleaning Panda

🧹 TidyTerms

❓ Problem Statement:

Users often struggle to understand lengthy and complex terms and conditions documents, leading to uninformed decisions and potential legal pitfalls. TidyTerms is a Chrome extension designed to simplify the process of understanding terms and conditions. The extension scans lengthy legal documents and provides concise, easy-to-understand highlights, helping users quickly grasp important points such as privacy policies, data usage, cancellation terms, and hidden fees. By leveraging OpenAI's GPT for AI-driven analysis, TidyTerms provides accurate and meaningful summaries, empowering users with clear and actionable information to foster informed decision-making and protect consumer rights. TidyTerms helps users understand complex legal documents quickly, enabling them to make informed decisions and avoid potential legal issues.

🛠️ Minimum Viable Product (MVP) Features

  • Document Scanning:

    • Ability to scan terms and conditions documents directly from web pages.
  • Key Highlights Extraction:

    • AI-driven analysis using OpenAI's GPT to extract and summarize key points, such as privacy policies, data sharing practices, and cancellation terms.
  • User-Friendly Summary:

    • Easy-to-read summaries that break down complex legal language into understandable bullet points.
  • Search Functionality:

    • Allows users to search for specific terms or clauses within the document.
  • Save & Share:

    • Options to save the summaries and share them via email or social media.
  • Comparison Feature:

    • Compare terms and conditions across different services to help users make informed choices.

🚀 Stretch Goals

  • Custom Alerts:

    • Notifications are given to users when significant changes are detected in the terms and conditions of their services.
  • Legal Jargon Glossary:

    • In-app glossary to explain common legal terms and jargon.
  • Interactive Tutorials:

    • Guides and tutorials on understanding common clauses and their implications.
  • Integration with E-Signature Services:

    • Direct integration with e-signature platforms to provide highlights before signing documents.

📅 Milestones

Week Tasks
Week One: Setup - Team Organization: Define roles and responsibilities.
- Version Control: Set up a Git repository.
- Environment Setup: Initialize your project with Node.js, React, and Express.
- Design Prototypes: Create UI designs using Figma.
Week Two: Finish Prototyping and Initial Setup - Figma Designs: Finalize design prototypes.
Backend:
- Set up the Express server.
- Implement registration and login functionality.
Frontend:
- Set up the Chrome extension manifest.
- Implement the registration and login pages using React.
- Create a basic popup UI.
Week Three: Core Feature Development Backend:
- Develop AI-driven key highlights extraction using OpenAI's GPT.
- Set up endpoints to process document scans.
Frontend:
- Implement document scanning functionality.
- Create the key highlights extraction page.
Week Four: User-Friendly Summary and Profile Page Backend:
- Develop user-friendly summary generation.
Frontend:
- Implement the summary page.
- Implement the profile page.
Week Five: Search Functionality and Save & Share Backend:
- Develop search functionality and save/share options.
Frontend:
- Implement search functionality.
- Implement save/share options.
Week Six: Custom Alerts and Comparison Feature Backend:
- Develop custom alerts for significant changes in terms.
- Implement comparison feature.
Frontend:
- Integrate custom alerts.
- Implement the comparison feature.
Week Seven: Integration and Testing - Integration: Integrate frontend with backend services.
- Testing: Conduct end-to-end testing.
- Fix bugs and ensure seamless functionality.
Week Eight: Last Minute Work - Address any remaining issues or refinements.
- Finalize all features.
- Prepare the project for presentation.
Week Nine: Presentation Preparation - Develop presentation materials.
- Rehearse presentations.
- Refine presentation based on feedback.
Week Ten: Presentations - Finalize presentation.
- Present the project to stakeholders or in a public setting.

💻 Tech Stack

HTML: For creating the popup UI.
CSS: For styling the popup UI.
JavaScript: For the logic of the extension.
JSON: For the manifest file.
OpenAI API: For AI text analysis and summarization.

🚧 Roadblocks and Possible Solutions

  1. ⚠️ Roadblock: Scalability and Processing Large Documents

    • Solution: Implement load-balancing and server-side caching to handle large document submissions efficiently while maintaining smooth performance.
  2. ⚠️ Roadblock: Miscommunication and Team Coordination

    • Solution: Use clear communication channels (Slack, Teams), daily stand-ups, and tools like Jira to keep team members aligned and track individual progress effectively.
  3. ⚠️ Roadblock: Scope Creep and Feature Management

    • Solution: Define the project scope early and establish a formal process to evaluate new feature requests, preventing unnecessary deviation from the original plan.
  4. ⚠️ Roadblock: Ensuring AI Accuracy in Summarization

    • Solution: Continuously improve machine learning models by training them with diverse legal datasets and create a fallback mechanism for ambiguous clauses.
  5. ⚠️ Roadblock: Team Burnout and Unforeseen Delays

    • Solution: Build buffer time into the schedule, redistribute workloads, and monitor for signs of burnout to adjust deadlines or shift resources if necessary.

🛠️ Required Tools

IDE: Visual Studio Code
Design: Figma
Version Control: Git
API: OpenAI API for GPT-based text summarization
Cloud: Any cloud service for hosting (e.g., Heroku, AWS, DigitalOcean)

🏆 Competition

  • Terms of Service; Didn't Read (ToS;DR):

    • Provides crowdsourced summaries and ratings of terms and conditions.
  • Guard:

    • An AI-driven app that analyzes and highlights key points in terms and conditions and privacy policies.
  • Clausehound:

    • Offers legal document analysis and summary, primarily for businesses.
  • Legalese Decoder:

    • Translates legal jargon into plain language.

🔧 Miscellaneous

Building a Chrome Extension YouTube Videos:

Git Commands

Command What it does
git branch Lists all the branches
git branch "branch name" Creates a new branch
git checkout "branch name" Switches to the specified branch
git checkout -b "branch name" Combines branch creation and checkout
git add . Stages all changed files
git commit -m "Testing123" Commits with a message
git push origin "branch" Pushes to the specified branch
git pull origin "branch" Pulls updates from the specified branch

🧑‍⚖️ The Court

  • Judge (Project Manager): Shreya S Ramani
  • Jury (Industry Mentor): Royce Mathews
  • Lawyer 1: Vivian Nguyen (Frontend)
  • Lawyer 2: Atreya Ghosh (Backend)
  • Lawyer 3: Srinitya Chirravuri (Frontend)
  • Lawyer 4: Arshia Puri (Backend)