privacybot - GitLite

KO | EN

gitlite — search

#javascript #python #typescript #golang #go #machine-learning #rust #deep-learning #linux #docker #ios #mcp #openai #open-source

privacybot

(★ 540)

No description available.

파일 탐색기

최종 버전 다운로드 (.zip)

- app.py
- client_secret.json
- corefunctions.py
- Google.py
- requirements.txt
- services_list_06May2021.csv
- test_services.csv
- - modules.xml
  - open-pro-react.iml
  - vcs.xml
  - workspace.xml
- - 9E2169D8A233A546.png
  - asset-manifest.json
  - bot_background_removed.svg
  - index.html
  - logo192.png
  - logo512.png
  - manifest.json
  - precache-manifest.3196fc94e5bab8ef74cbc7d7e8259917.js
  - privacybot_head.svg
  - robots.txt
  - service-worker.js
- - 9E2169D8A233A546.png
  - bot_background_removed.svg
  - index.html
  - logo192.png
  - logo512.png
  - manifest.json
  - privacybot_head.svg
  - robots.txt
- - App.js
  - App.test.js
  - index.js
  - serviceWorker.js
  - setupTests.js
- CHANGELOG.md
- craco.config.js
- package-lock.json
- package.json
- tailwind.config.js
- yarn.lock
.gitignore
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/privacybot-berkeley/privacybot

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd privacybot

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd PB_UI

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

3. Python

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

pip install -r app/requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

파이썬 스크립트(또는 모듈)를 실행합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PROJECT NO LONGER SUPPORTED
## As of 9.28.21 this project has been depreciated and Google Oauth verification is not supported. You can still run the tool but you need to setup your own instance of Google Oauth credentials.

# PrivacyBot

PrivacyBot is a simple automated service to initiate CCPA deletion requests with databrokers.

## How It Works
1. PrivacyBot comprises of a React Frontend and a Python Flask Backend web architecture
2. After starting the application, PrivacyBot initiates an OAuth authentication request with your Gmail account. You will be asked to allow PrivacyBot to read, compose and send emails from your Gmail account. 
3. Once the authentication is successfully completed, depending on the data provided to the Flask API, a CCPA data delete email is drafted and sent to the data brokers chosen. 
4. A confirmation email is sent back to you listing all the databrokers to whom the email was sent.

## Prerequisites

1. A Gmail account - This is the email from which you will be initiating the data delete requests. PrivacyBot's data deletion process is most effective if this email is the one which you use the most for personal use. 
2. Install Python 3 (https://www.python.org/downloads/)
3. Ensure pip3 is installed (https://pip.pypa.io/en/stable/installing/)
4. Install node https://nodejs.org/en/download/

## Usage - Running PrivacyBot

#### 1. Download zip file from Github Repo and unzip

#### 2. Open Visual Studio Code and open the “privacybot-private-main” folder

#### 3. Open split terminal in VS Code (or any two terminals/cmd prompts on your machine). We will be using one terminal to run the Flask app and the other one to run the React app.

### Start the Flask Server

#### 1. Create and activate a Python Virtual Environment

The below commands create and activate a virtual environment named "PB_venv".

`$ python3 -m venv PB_venv`

`$ source PB_venv/bin/activate`

#### 2. Navigate to `app` folder and install from requirements.txt

`$ cd app`

`$ pip3 install -r requirements.txt`

To confirm required packages are installed - see if “flask_cors” is installed:

`$ pip3 list`

#### 3: Start the Flask App
Run the below commands within the activated virtual environment.

`$ flask run`

The above commands will start the flask application. It can now be accessed through http://127.0.0.1:5000/

Leave this terminal instance as is, and open the second terminal instance.

### Start the React Application
PFB a step by step list of commands that informs how to install an instance of the React Server.

#### 1. Run the following commands in the second terminal to navigate to the `app/PB_UI` folder

`$ cd app`

`$ cd PB_UI`

#### 2. Check to make sure node and npm is correctly installed

`$ node -v`

`$ npm -v`

#### 3. Install the required packages using npm install. Fix any vulnerabilities found.

`$ npm install`

`$ npm audit fix`

#### 4. Start the React Application by running the below commands. This may take a moment.

`$ npm run build`

`$ npm start`

#### 5. PrivacyBot will now be running on your local machine. 
You will now be able to fill in the required details on the browser form that is opened by the above React commands. Once the required details are filled in and your GMAIL account is authenticated successfully, PrivacyBot will automatically send data deletion requests to the chosen list of data brokers! Yay!

#### 6. Remove access to PrivacyBot from your Gmail account