v1.0 Init commit

Author: areebahmeddd

.gitignore

@@ -1,4 +1,5 @@
-.venv
-__pycache__
+# Python related
+.venv/
+__pycache__/
 .env
-secrets.toml
+secrets.toml

README.md

@@ -1,12 +1,12 @@
 <p align="center">
-  <img src="https://github.com/areebahmeddd/GodsEye/blob/main/assets/logo.png" alt="Project Logo">
+  <img src="assets/logo-transparent.png" alt="Project Logo">
 </p>
 
 ## Project Description
 
-The automated feedback system uses web crawlers to create a dataset of news articles, scrape article URLs, and optical character recognition technology to extract content from e-papers. The system is built with the Streamlit framework to generate graphs using the Plotly library for visualization of scraped data.
+The automated news feedback system uses web crawlers to create a dataset of news articles, scrape article URLs, and optical character recognition technology to extract content from e-papers. The system is built with the Streamlit framework to generate graphs using the Plotly library for visualization of scraped data.
 
-Additionally, the system includes a chatbot (powered by the Gemini API) that provides perspective on the latest news for users and a Chrome extension for real-time fake news detection.
+Additionally, the system includes a chatbot (powered by Gemini API) that provides perspective on the latest news for users and a Chrome extension for real-time fake news detection.
 
 ## System Architecture
 
@@ -41,68 +41,89 @@ Additionally, the system includes a chatbot (powered by the Gemini API) that pro
 ---
 
 <p align="center">
-  <img src="https://github.com/areebahmeddd/GodsEye/blob/main/assets/architecture.png" alt="System Architecture">
+  <img src="assets/architecture.png" alt="System Architecture">
 </p>
 
 ## Getting Started
 
 Follow these steps to set up and run the GodsEye software on your local machine, or you can watch the [demo video](https://youtube.com/watch?v=sWd4kOQU9as).
 
-## Installation
+### Installation
 
 1. Clone the repository to your local machine:
-    ```shell
-    git clone https://github.com/areebahmeddd/GodsEye.git
-    ```
+
+   ```shell
+   git clone https://github.com/areebahmeddd/GodsEye.git
+   ```
 
 2. Navigate to the project directory:
-    ```shell
-    cd GodsEye
-    ```
+
+   ```shell
+   cd GodsEye
+   ```
 
 3. Create a virtual environment (optional but recommended):
-    ```shell
-    python -m venv .venv
-    ```
+
+   ```shell
+   python -m venv .venv
+   ```
 
 4. Activate the virtual environment:
-    - Windows:
-        ```shell
-        .venv\Scripts\activate
-        ```
-    - macOS and Linux:
-        ```shell
-        source .venv/bin/activate
-        ```
+
+   - **Windows**:
+     ```shell
+     .venv\Scripts\activate
+     ```
+   - **macOS and Linux**:
+     ```shell
+     source .venv/bin/activate
+     ```
 
 5. Install the project dependencies:
-    ```shell
-    pip install -r requirements.txt
-    ```
 
-6. Set up the Chrome extension:
-    - Open Chrome and go to `chrome://extensions`.
-    - Enable "Developer mode" (top right corner).
-    - Click "Load unpacked".
-    - Select the `browser-extension` folder in the GodsEye repository.
+   ```shell
+   pip install -r requirements.txt
+   ```
+
+6. Set up the configuration files:
+
+   - Create a `secrets.toml` file in the `.streamlit` directory with the following template:
 
-## Usage
+   ```ini
+   [admin]
+   email = "[email protected]"
+   app_pass = "your_app_password"
+
+   [gemini]
+   api_key = "your_gemini_api_key"
+   ```
+
+7. Set up the Chrome extension:
+   - Open Chrome and go to `chrome://extensions`.
+   - Enable "Developer mode" (top right corner).
+   - Click "Load unpacked" (top left corner).
+   - Select the `browser-extension` folder in the GodsEye repository.
+
+### Usage
 
 1. Launch the application by clicking the run button in the top right of VS Code, or execute:
-    ```shell
-    python python-app/app.py
-    ```
+
+   ```shell
+   python python-app/app.py
+   ```
 
 2. Using the Browser Extension:
-    - Navigate to any of the following supported websites:
-      - https://www.ndtv.com
 
-      **NOTE**: The subdomain https://www.ndtvprofit.com is currently unsupported due to a different HTML structure.
+   - Navigate to any of the following supported websites:
+
+     - https://www.ndtv.com
+
+     **NOTE**: The subdomain https://www.ndtvprofit.com is currently unsupported due to a different HTML structure.
 
-    - Select and open any article. The browser extension will be displayed on the right side of the screen. Click on the extension icon to access detailed information.
+   - Select and open any article. The browser extension will be displayed on the right side of the screen. Click on the extension icon to access detailed information.
 
 3. For Contributors:
-    - To apply changes made to the browser extension, visit `chrome://extensions`, click the "Update" button at the top left, and reload the article page to see the updates.
+   - To apply changes made to the browser extension, visit `chrome://extensions`, click the "Update" button at the top left, and reload the article page to see the updates.
 
 ## License