tweaks during dry run

Author: johnckealy

.env.local.example .env.example.env.local.example renamed to .env.example

@@ -1,8 +1,8 @@
+# App environment (development, preview, production)
+APP_ENV=development
+
 # Your Supabase project URL: Note the ip address is tailored for use over your local network (you probably don't need to change this)
-SUPABASE_URL=http://127.0.0.1:54321
+SUPABASE_URL=http://192.168.1.102:54321
 
-# Your Supabase secret key (get this by running supabase start or supabase status)
+# Your Supabase anon/public key (get this by running supabase start or supabase status)
 SUPABASE_SECRET_KEY=get-this-from-running-supabase-start-or-supabase-status
-
-# App environment (development, preview, production)
-APP_ENV=development

.github/workflows/scheduled-backups.yaml

@@ -5,12 +5,13 @@
 # This workflow backs up the Supabase database (roles, schema, and data) to
 # Google Cloud Storage. It can be triggered manually or on a schedule.
 #
-# NOTE: THIS WORKFLOW ISN'T OFFICIALLY SUPPORTED BY MOSAYIC YET. YOU CAN USE IT IF YOU
+# NOTE: THIS WORKFLOW ISN'T OFFICIALLY SUPPORTED. YOU CAN USE IT IF YOU
 # FIGURE OUT HOW TO SET UP THE REQUIRED GCP PERMISSIONS AND SECRETS YOURSELF (GCP STORAGE
 # AND GITHUB ACTIONS SECRETS). OTHERWISE, IGNORE IT FOR NOW UNTIL THE FEATURE BECOMES
 # SUPPORTED IN A MORE USER-FRIENDLY WAY. NOTE THAT IF YOU'RE USING THE PAID VERSION OF
 # SUPABASE, THEY PROVIDE AUTOMATIC BACKUPS AS PART OF THE SERVICE, SO YOU WON'T NEED THIS.
 #
+# Get in touch with John if you're interested in this feature.
 #
 # Requirements:
 # - SUPABASE_DB_URL: Database URL (e.g., postgresql://postgres:[PASSWORD]@db.<ref>.supabase.co:5432/postgres)

.github/workflows/supabase-deploy-migrations.yaml

@@ -7,20 +7,19 @@
 #
 # Requirements:
 # - The Python API codebase with the migrations folder up to do date.
-# - A GitHub Actions Secret named 'SUPABASE_DB_URL_PROD', containing the database URL.
+# - A GitHub Actions Secret named 'DATABASE_CONNECTION_STRING', containing the database URL.
 #      You can find this URL in the Supabase dashboard; you'll need to also insert the
-#      dataabase password into the URL.
+#      database password into the URL.
 #
-# This workflow is currently disabled for pushes to 'main' branch. To enable it, change the branch
-# name from 'none' to 'main' in the 'push' event section.
+# This workflow is currently disabled. To enable it, set the on: triggers to the desired branches/events.
 #
 ###################################
 
 name: Deploy Supabase Migrations
 
 on:
   release:
-    types: [none]  # set this to 'published' to run on release creation
+    types: [none]  # set this to 'published' to run on release creation (Recommended)
   push:
     branches:
       - none   # set this to 'main' to run on pushes to the main branch
@@ -34,13 +33,13 @@ jobs:
       uses: actions/checkout@v3
 
     - name: Setup Supabase CLI
-      # if: github.event_name == 'release'
+      if: github.event_name == 'release'
       uses: supabase/setup-cli@v1
       with:
         version: latest
 
     - name: Push Supabase Migrations to Prod
-      # if: github.event_name == 'release'
+      if: github.event_name == 'release'
       env:
         DATABASE_CONNECTION_STRING: ${{ secrets.DATABASE_CONNECTION_STRING }}
       run: |

.gitignore

@@ -1,5 +1,7 @@
 .env*
-!.env.local.example
+!.env..example
+!.env.example
+
 
 
 *.py[cod]

README.md

@@ -1,6 +1,6 @@
-# Mosayic Python API
+# Python API
 
-A FastAPI backend application with Supabase database integration.
+A FastAPI backend application with Supabase database integration, designed to compliment the React Native Mobile application Stack at Kealy Studio.
 
 ## Tech Stack
 
@@ -44,7 +44,7 @@ python-api/
 
 1. Install dependencies:
    ```bash
-   uv sync
+   uv sync --all-groups
    ```
 
 2. Start local Supabase:
@@ -54,12 +54,13 @@ python-api/
 
 3. Copy environment variables:
    ```bash
-   cp .env.local.example .env.local
+   mv .env.example .env
+   mv supabase/.env.example supabase/.env
    ```
 
 4. Run the development server:
    ```bash
-   uv run uvicorn app.main:app --reload --port 8080
+   uv run uvicorn app.main:app --host 0.0.0.0 --port 8080
    ```
 
 ### Running Tests
@@ -68,40 +69,36 @@ python-api/
 uv run pytest
 ```
 
-### Docker
 
-Build and run the container:
-
-```bash
-docker build -t mosayic-api .
-docker run -p 8080:8080 mosayic-api
-```
-
-## Environment Variables
-
-Configure in `.env.local` for development:
-
-| Variable | Description |
-|----------|-------------|
-| `supabase_url` | Supabase project URL |
-| `supabase_secret_key` | Supabase service role key |
-| `api_key` | API authentication key |
-| `debug_mode` | Enable debug mode (default: false) |
-| `environment` | Environment name (development/production) |
 
 ## Database
 
 Supabase migrations are in `supabase/migrations/`. Current schema includes:
 
 - `users` - User profiles synced with Supabase Auth
-- `items` - User-owned items
+- `devices` - A user may have many devices
+
 
-Run migrations locally:
-```bash
-supabase db push
-```
 
 ## Deployment
 
 - **API**: Deployed to Google Cloud Run (see `.github/workflows/gcp-deploy.yaml`)
 - **Database**: Migrations deployed via GitHub Actions (see `.github/workflows/supabase-deploy-migrations.yaml`)
+
+The command to deploy is:
+```
+# Set the variables
+export PROJECT_ID=goat-together
+export REGION=eu-west1
+export SERVICE_NAME=goattogether-api
+
+# Get the project number
+PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
+
+# Deploy to Cloud Run
+gcloud run deploy $SERVICE_NAME \
+  --source . \
+  --region=$REGION \
+  --project=$PROJECT_ID \
+  --allow-unauthenticated
+```

app/core/settings.py

@@ -7,7 +7,7 @@
 
 class Settings(BaseSettings):
     model_config = SettingsConfigDict(
-        env_file=".env.local",
+        env_file=".env",
         extra='allow',
         env_file_encoding='utf-8'
     )

app/main.py

@@ -4,22 +4,22 @@
 
 Later, if you need to more control, you can access the FastAPI app instance directly, or just create your own.
 """
-from fastapi import Depends
-from supabase_auth.types import User
-
-from app import app
-from app.core.auth import get_current_user
-from app.routes.auth_router import router as auth_router
+from fastapi import Depends
+from supabase_auth.types import User
 
+from app import app
+from app.core.auth import get_current_user
+from app.routes.auth_router import router as auth_router
 
-@app.get("/public")
+
+@app.get("/")
 async def public_route():
-    return {"message": "Welcome to your Python API!"}
+    return {"message": "Welcome to the Python API!"}
+
+
+@app.get("/protected")
+async def protected_route(user: User = Depends(get_current_user)):
+    return {"message": "You are authenticated!", "user_id": user.id}
 
 
-@app.get("/protected")
-async def protected_route(user: User = Depends(get_current_user)):
-    return {"message": "You are authenticated!", "user_id": user.id}
-
-
-app.include_router(auth_router)
+app.include_router(auth_router)

app/routes/auth_router.py

@@ -3,7 +3,7 @@
 
 from app.core.auth import delete_auth_user, get_current_user
 
-router = APIRouter(prefix="/auth", tags=["auth"])
+router = APIRouter(prefix="/auth", tags=["Auth"])
 
 
 @router.delete("/users/{user_id}")

supabase/.env.example

@@ -0,0 +1,6 @@
+# Google OAuth credentials for Supabase Auth (get secret from Google Cloud Console)
+SUPABASE_AUTH_EXTERNAL_GOOGLE_CLIENT_ID=<get this from Google Cloud Console>
+SUPABASE_AUTH_EXTERNAL_GOOGLE_SECRET=<get this from Google Cloud Console>
+
+# Supabase PostgreSQL password (DO NOT REFERENCE THIS IN YOUR CODE)
+SUPABASE_DB_PASSWORD=your-postgres-password