Welcome to TLDR

---

---

Table of Contents

• Product Overview
• MVP and Future Features
• Deployment
• Built With
• Database Schema
• Endpoints
• Running the Test Suit
• Front-End Repository
• Contributors

Product Overview

Our web platform is a tool that helps you understand the terms and conditions of services you sign up for in a simpler way. Instead of having to read through long and complex legal documents, you can copy and paste them into our platform and select the things you're most concerned about, like privacy or recurring payments. Our platform will then show you a summary of how those specific things might affect you, with an overall score that helps you see how good or bad they are. We also give you suggestions for what you can do if you don't like what you see. We want to make it easier for you to understand what you're agreeing to when you use a service, and help you protect your rights.

MVP and Future Features

MVP

• Integration with ChatGPT's API: The first and most important build out is to integrate our platform with ChatGPT's API, which will analyze the terms and conditions of service providers and generate easy-to-read summaries.

Future Features

• User Authentication and Authorization: To ensure the security of our users' data, we need to implement a robust authentication and authorization system that restricts access to sensitive information only to authorized users.
• Data Storage and Retrieval: We need to implement a system for storing and retrieving user data, including the terms and conditions they input and their selected concerns, follow-up actions, and other preferences. This data will be used to generate summaries and suggestions for future interactions.
• Follow-up Actions Automation: To enable users to take follow-up actions with ease, we need to build out a system for automating tasks such as generating emails, creating events in Google Calendar, and sending reminders. This will help users take control of their interactions with service providers and protect their interests.
• Scalability: As the user base grows, we need to ensure that our platform is scalable and can handle large volumes of data and traffic. We need to implement best practices for performance optimization, load balancing, and fault tolerance to ensure that the platform remains stable and reliable.

Deployment

Back-End

TLDR API Website

Front-End

TLDR Website

Built With

Database Schema

Endpoints

Query

POST:User TOS Concerns Summary

Request:

POST /api/v1/queries

Params:

Name	Requirement	Type	Description
tos	Required	string	Terms of Service
concerns	Optional	string	User Concerns

Response:

Result	Status
Success	201
Failure	401
Internal Server Error	500

{
  "data": [
      {
          "response": {
              "subscription": {
                  "impact": "The Netflix Terms of Use outlines the subscription service that allows members to access entertainment content over the Internet on certain Internet-connected TV's, computers and other devices. It also outlines the payment method that is charged for the subscription service.",
                  "actionable": "The Terms of Use outlines the steps that members must take to cancel their subscription service, as well as the steps that must be taken to ensure that the subscription service is not renewed after the cancellation.",
                  "ranking": 8
              }
          }
      },
      {
          "response": {
              "privacy": {
                  "impact": "Netflix Inc. states that they may collect personal information from members, including name, address, email address, payment information, and other information. They may also collect information about members' use of the service, such as the titles of movies and TV shows watched and the duration of the viewing session.",
                  "actionable": "Members can control the amount of personal information they provide to Netflix Inc. by adjusting their account settings. They can also control the amount of information Netflix Inc. collects about their use of the service by adjusting their privacy settings.",
                  "ranking": 8
              }
          }
      }
  ]
}

---

User

GET: User

Request:

GET /api/v1/users

Params:

Name	Requirement	Type	Description
username	Required	string	Username

Response:

Result	Status
Success	200
Failure	401
Internal Server Error	500

{
 "data": {
   "id": "1",
   "name": "user",
  }
}

---

Running the Test Suite

1. Run python3 -m venv myenv
2. Run pip install -r requirements.txt
3. Run python manage.py migrate
4. Run pytest
5. Run coverage run --source='tldr_app' -m pytest tldr_app/tests/*.py

Front-End Repository

TLDR Front-End Repo

Contributors

| Isaac Alter Github LinkedIn | Axel De La Guardia Github LinkedIn | Elle Majors Github LinkedIn | Hady Matar Github LinkedIn | Conner Van Loan Github LinkedIn |