Merge pull request #126 from VineetBala-AOT/main

VineetBala-AOT · web-flow · commit 906ee95e1afd · 2025-08-14T12:08:40.000-07:00
Updating the readme for condition repository
diff --git a/README.md b/README.md
@@ -1,49 +1,58 @@
-## Installation
+# EPIC.conditions
+A project for the Environmental Assessment Office to manage conditions required for a certificate
 
-1. Clone the repository:
-   
-   `git clone https://github.com/bcgov/EPIC.conditions`
+Condition Repository is an online application designed to extract, store, and present environmental assessment conditions from PDF documents.
 
-   `cd EPIC.conditions`
-   
+### Key Benefits
+- **Conditions Repository**: A single repository providing access to all conditions across multiple projects
+- **Consolidated Conditions View**: Enables viewing of all conditions for a project, including amendments to the original condition documents, in a unified format
 
-2. Set up a virtual environment:
-   
-    `python -m venv venv`
+## Condition Repository Setup Instructions
 
-3. Activate the virtual environment:
-   - On Windows:
-   
-        `venv\Scripts\activate`
-   - On Linux/MacOS:
-   
-        `source venv/bin/activate`
+This document outlines the setup instructions for both the backend and front-end components of the project. Ensure you follow the steps in sequence for a smooth setup.
 
-4. Install the required packages:
-   
-    `pip install -r requirements.txt`
+## Backend Setup
+See [API Application Readme](condition-api/README.md)
+
+## Front End Setup
+See [Web Application Readme](condition-web/README.md)
 
-5. Create a file named `.env` in the root directory of the project and add your OpenAI API key:
-   ```text
-   OPENAI_API_KEY=openai_api_key_here
-   ```
 
 ## Usage
 
 ### Individual PDFs:
 
-Follow the [condition-parser README](./condition-parser) to extract info and get a JSON.
-
-Follow the [condition-lib README](./condition-lib) to add the extracted JSON to the PostgreSQL database.
+### Extracting conditions and related details from PDF documents
+See [Data Extractor Readme](condition-parser/README.md)
 
-*Note: gradio_ui.py in this directory is depreciated.* 
+### Importing extracted conditions into the database
+See [Data Loader Readme](condition-loader/README.md)
 
 ### Multiple PDFs (Batch Processing):
-
-See [batch processing README](./batch_api_calling).
+See [Batch Processing README](./batch_api_calling).
 
 For verifying the output of a batch, see [manual verification README](./batch_api_calling/manual_verification/).
 
+*Note: gradio_ui.py in this directory is depreciated.* 
+
+## Directory Structure
+
+    .github/                   - PR, CI action workflows and Issue templates
+    /docs                      - Miscellaneous documentations
+    condition-web/             - Condition Web application root
+    └── src/                   - React.js application
+    condition-api/             - Condition API Application Root
+    ├── src/                   - Python flask application
+    │   └── met_api/           - Models, Resources and Services
+    └── migrations             - Database migration scripts
+    └── tests/                 - API application tests
+        └── unit/              - Python unit tests
+    condition-loader/          - Module for loading extracted conditions into the database
+    ├── condition_jsons/       - Collection of extracted condition JSON files
+    └── loadConditions         - Script for importing the extracted conditions into the database
+    condition-parser/          - Module for extracting conditions and related details from PDF documents.
+    openshift/                 - OpenShift templates and documentation
+    LICENSE                    - License
 
 ## Demo
 [![Condition extractor demo](https://github.com/user-attachments/assets/a25b0093-b04b-4ddb-89cd-153ddaa582cd)](https://bcgov.sharepoint.com/:b:/t/04612/EYzyqtlP82BJt8ocy2AISNwBwiS-2BgJ23NqRZts-Nn6jw?e=CM1Nt3)
@@ -57,3 +66,19 @@ For verifying the output of a batch, see [manual verification README](./batch_ap
 - [OpenAI function calling documentation](https://platform.openai.com/docs/guides/function-calling)
 - [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat)[.](https://github.com/user-attachments/assets/cac337de-097d-4bfb-b946-56b98a2f1e1d)
 
+
+## License
+
+    Copyright © 2024 Province of British Columbia
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
diff --git a/condition-api/README.md b/condition-api/README.md
@@ -4,34 +4,80 @@ A condition Python flask API application to be used as a template.
 
 ## Getting Started
 
-### Development Environment
-* Install the following:
-    - [Python](https://www.python.org/)
-    - [Docker](https://www.docker.com/)
-    - [Docker-Compose](https://docs.docker.com/compose/install/)
-* Install Dependencies
-    - Run `make setup` in the root of the project (condition-api)
-* Start the databases
-    - Run `docker-compose up` in the root of the project (condition-api)
+## Backend Setup in WSL
 
-## Environment Variables
+## Step 1. Install Python 3.12.4
+Ensure Python 3.12.4 is installed in your WSL environment. Download it from the [official Python website](https://www.python.org/downloads/release/python-3124/).
 
-The development scripts for this application allow customization via an environment file in the root directory called `.env`. See an example of the environment variables that can be overridden in `sample.env`.
+## Step 2. Set Up PYTHONPATH
+Add the following line to your `.bashrc` or `.zshrc` file to set the `PYTHONPATH` environment variable:
+export PYTHONPATH="/path/to/condition-api:${PYTHONPATH}"
 
-## Commands
+## Step 3. Configure Environment Variables
+Create a `.env` file in your condition-api with the necessary configurations. Reference sample.env to see what variables you need to configure
 
-### Development
+## Step 4. Start Docker Compose
+In a separate terminal, launch Docker Compose to set up your containers:
+docker-compose up
 
-The following commands support various development scenarios and needs.
-Before running the following commands run `. venv/bin/activate` to enter into the virtual env.
+## Step 5. Run Setup
+Navigate to your project directory and run the setup command to prepare your development environment:
+make setup
 
+## Step 6. Run Server
+Once the setup is completed use make run to start the server:
+make run
 
-> `make run`
->
-> Runs the python application and runs database migrations.  
+
+## Backend Setup on Windows
+
+## Step 1: Download the Latest Python Version
+
+1. Visit the official Python website: [Python Downloads](https://www.python.org/downloads/)
+2. Download and install the latest version of Python for your operating system.
+
+
+## Step 2: Set Environment Variables
+
+1. Set the `FLASK_APP` and `FLASK_ENV` environment variables:
+    - set FLASK_APP=app.py 
+    - set FLASK_ENV=development
+      
+2. Configure `PYTHONPATH` to your project's folder location up to `condition-api/src`:
+    - set PYTHONPATH=path\to\condition-api\src &&    PYTHONPATH=path\to\condition-api
+
+## Step 3: Start Docker
+
+1. Open a terminal.
+2. Navigate to the `condition-api` directory:
+    cd condition-api
+
+3. Run the following command to start the services using Docker Compose:
+    docker-compose up
+
+## Step 4: Set Up `condition-api`
+
+1. Open a separate terminal.
+
+2. Navigate to the `` directory:
+    cd condition-api
+
+3. Create a virtual environment. Refer to the official Python documentation on how to create a virtual environment: [Python venv](https://docs.python.org/3/library/venv.html).
+    - python -m venv venv
+
+4. Activate the virtual environment:
+    - venv\Scripts\activate
+
+5. Install the required Python packages from both `dev.txt` and `prod.txt` requirements files:
+    - python -m pip install -r path/to/requirements/dev.txt
+    - python -m pip install -r path/to/requirements/prod.txt
+
+6. Run your Flask app using the Flask CLI:
+    - python -m flask run -p 5000
+
+
+Runs the python application and runs database migrations.
 Open [http://localhost:5000/api](http://localhost:5000/api) to view it in the browser.<br/>
-> The page will reload if you make edits.<br/>
-> You will also see any lint errors in the console.
 
 > `make test`
 >
@@ -45,6 +91,4 @@ Open [http://localhost:5000/api](http://localhost:5000/api) to view it in the br
 
 ### Visual Studio Code
 
-Ensure the latest version of [VS Code](https://code.visualstudio.com) is installed.
-
-The [`launch.json`](.vscode/launch.json) is already configured with a launch task (CONDITION-API Launch) that allows you to launch chrome in a debugging capacity and debug through code within the editor. 
+Ensure the latest version of [VS Code](https://code.visualstudio.com) is installed.
diff --git a/condition-parser/README.md b/condition-parser/README.md
@@ -1,37 +1,37 @@
-## Installation
+# CONDITION-PARSER
 
-1. Clone the repository:
+Gradio application for extracting conditions and related details from PDF documents.
+
+## Getting Started
+
+## Step 1. Clone the repository:
    
-   `git clone https://github.com/bcgov/EPIC.conditions`
+    - `git clone https://github.com/bcgov/EPIC.conditions`
 
-   `cd condition-parser`
+    - `cd condition-parser`
    
 
-2. Set up a virtual environment:
+## Step 2. Set up a virtual environment:
    
-    `python -m venv venv`
+    - `python -m venv venv`
 
-3. Activate the virtual environment:
+## Step 3. Activate the virtual environment:
    - On Windows:
    
         `venv\Scripts\activate`
    - On Linux/MacOS:
    
         `source venv/bin/activate`
 
-4. Install the required packages:
+## Step 4. Install the required packages:
    
-    `pip install -r requirements.txt`
+    - `pip install -r requirements.txt`
 
-5. Create a file named `.env` in the root directory of the project and add your OpenAI API key:
+## Step 5. Create a file named `.env` in the root directory of the project and add your OpenAI API key:
    ```text
    OPENAI_API_KEY=openai_api_key_here
    ```
 
-## Usage
-
-### Individual PDFs:
-
-Run the gradio UI by executing the following command in the root of the directory (/condition-parser):
+## Step 6. Run the gradio UI by executing the following command in the root of the directory (/condition-parser):
 
-`python gradio_ui.py`
+    - `python gradio_ui.py`
diff --git a/condition-web/README.md b/condition-web/README.md
@@ -1,3 +1,20 @@
+# CONDITION-WEB
+
+## Getting Started
+
+### 1. Navigate to Front End Directory
+Change to the front-end directory:
+cd condition-web
+
+### 2. Install Dependencies
+Install necessary npm packages:
+npm install
+
+### 3. Run Development Server
+Launch the development server:
+npm run dev
+
+
 # React + TypeScript + Vite
 
 This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
diff --git a/docs/Condition_Repository_Architecture.png b/docs/Condition_Repository_Architecture.png
diff --git a/docs/Condition_Repository_Flow.png b/docs/Condition_Repository_Flow.png
