Postgres

.github/workflows/dependency-review.yml

@@ -25,6 +25,7 @@ permissions:
 
 jobs:
   dependency-review:
+    if: github.repository_visibility == 'public'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout repository'

.github/workflows/pylint.yml

@@ -17,8 +17,6 @@ jobs:
 
     - name: Install Poetry
       uses: abatilo/actions-poetry@v3
-      with:
-        poetry-version: "1.8.3"
 
     - name: Configure Poetry
       run: |

Dockerfile

@@ -0,0 +1,34 @@
+# Use a single stage build with FalkorDB base image
+FROM falkordb/falkordb:latest
+
+ENV PYTHONUNBUFFERED=1 \
+    FALKORDB_HOST=localhost \
+    FALKORDB_PORT=6379
+
+USER root
+
+# Install Python and pip, netcat for wait loop in start.sh
+RUN apt-get update && apt-get install -y \
+    python3 \
+    python3-pip \
+    netcat-openbsd \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+# Copy requirements and install Python dependencies
+COPY requirements.txt .
+RUN python3 -m pip install --no-cache-dir --break-system-packages -r requirements.txt
+
+# Copy application code
+COPY . .
+
+# Copy and make start.sh executable
+COPY start.sh /start.sh
+RUN chmod +x /start.sh
+
+EXPOSE 5000 6379 3000
+
+
+# Use start.sh as entrypoint
+ENTRYPOINT ["/start.sh"]

README.md

@@ -5,10 +5,61 @@
 
 # Text2SQL
 
+Text2SQL is a web application that allows users to interact with databases using natural language queries, powered by AI and graph database technology.
+
+## Setup
+
+### Prerequisites
+
+- Python 3.8+
+- Poetry (for dependency management)
+- FalkorDB instance (or Redis with FalkorDB module)
+
+### Installation
+
+1. Clone the repository
+2. Install dependencies with Poetry:
+   ```bash
+   poetry install
+   ```
+
+3. Set up environment variables by copying `.env.example` to `.env` and filling in your values:
+   ```bash
+   cp .env.example .env
+   ```
+
+### OAuth Configuration
+
+This application supports authentication via Google and GitHub OAuth. You'll need to set up OAuth applications for both providers:
+
+#### Google OAuth Setup
+
+1. Go to [Google Cloud Console](https://console.developers.google.com/)
+2. Create a new project or select an existing one
+3. Enable the Google+ API
+4. Go to "Credentials" and create an OAuth 2.0 Client ID
+5. Add your domain to authorized origins (e.g., `http://localhost:5000`)
+6. Add the callback URL: `http://localhost:5000/login/google/authorized`
+7. Copy the Client ID and Client Secret to your `.env` file
+
+#### GitHub OAuth Setup
+
+1. Go to GitHub Settings → Developer settings → OAuth Apps
+2. Click "New OAuth App"
+3. Fill in the application details:
+   - Application name: Your app name
+   - Homepage URL: `http://localhost:5000`
+   - Authorization callback URL: `http://localhost:5000/login/github/authorized`
+4. Copy the Client ID and Client Secret to your `.env` file
+
+### Running the Application
+
 ```bash
 poetry run flask --app api.index run
 ```
 
+The application will be available at `http://localhost:5000`.
+
 ## Introduction
 
 ![image](https://github.com/user-attachments/assets/8b1743a8-1d24-4cb7-89a8-a95f626e68d9)