Update with instructions on running locally

.gitignore

@@ -1,3 +1,4 @@
 __pycache__
 .vscode
-supabase/
+supabase/.branches
+supabase/.temp

Dockerfile

@@ -18,18 +18,18 @@ RUN --mount=type=cache,target=$POETRY_CACHE_DIR poetry install --without dev --n
 FROM python:3.11-slim-buster as runtime
 
 # Get secret DB_URL and output it to /test at buildtime
-RUN --mount=type=secret,id=DB_URL,mode=0444,required=true \
-   cat /run/secrets/DB_URL > /test
+# RUN --mount=type=secret,id=DB_URL,mode=0444,required=true \
+#    cat /run/secrets/DB_URL > /test
 
 ENV VIRTUAL_ENV=/app/.venv \
     PATH="/app/.venv/bin:$PATH"
 
 COPY --from=builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
 
-WORKDIR /app
+COPY image_search /image_search
+COPY static /static
+COPY images /images
 
-COPY image_search /app/image_search
-COPY static /app/static
-COPY images /app/images
+RUN ls -la ${VIRTUAL_ENV}
 
 CMD ["uvicorn", "image_search.main:app", "--host", "0.0.0.0", "--port", "7860"]

README.md

@@ -8,4 +8,21 @@ pinned: false
 license: apache-2.0
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+You can run this space locally by clicking on the three dots menu next to the Settings option. Then click on Run with Docker.
+
+### Getting started
+
+Firstly lets seed our database using the `/seed` endpoint:
+
+```
+http://localhost:7860/seed
+```
+
+Now you can do your first search using the `/search` endpoint:
+
+```
+http://localhost:7860/search?query=grapes
+```
+
+or you can use the UI by visiting `http://localhost:7860/`
+

image_search/main.py

@@ -86,8 +86,8 @@ def search(query: Union[str, None] = None):
     return {"result": result, "query": query}
 
 
-# app.mount("/images", StaticFiles(directory="images"), name="images")
-# app.mount("/", StaticFiles(directory="static", html=True), name="static")
+app.mount("/images", StaticFiles(directory="images"), name="images")
+app.mount("/", StaticFiles(directory="static", html=True), name="static")
 
 
 @app.get("/")

supabase/config.toml

@@ -0,0 +1,82 @@
+# A string used to distinguish different Supabase projects on the same host. Defaults to the working
+# directory name when running `supabase init`.
+project_id = "image-search"
+
+[api]
+# Port to use for the API URL.
+port = 54321
+# Schemas to expose in your API. Tables, views and stored procedures in this schema will get API
+# endpoints. public and storage are always included.
+schemas = ["public", "storage", "graphql_public"]
+# Extra schemas to add to the search_path of every request. public is always included.
+extra_search_path = ["public", "extensions"]
+# The maximum number of rows returns from a view, table, or stored procedure. Limits payload size
+# for accidental or malicious requests.
+max_rows = 1000
+
+[db]
+# Port to use for the local database URL.
+port = 54322
+# The database major version to use. This has to be the same as your remote database's. Run `SHOW
+# server_version;` on the remote database to check.
+major_version = 15
+
+[studio]
+# Port to use for Supabase Studio.
+port = 54323
+
+# Email testing server. Emails sent with the local dev setup are not actually sent - rather, they
+# are monitored, and you can view the emails that would have been sent from the web interface.
+[inbucket]
+# Port to use for the email testing server web interface.
+port = 54324
+smtp_port = 54325
+pop3_port = 54326
+
+[storage]
+# The maximum file size allowed (e.g. "5MB", "500KB").
+file_size_limit = "50MiB"
+
+[auth]
+# The base URL of your website. Used as an allow-list for redirects and for constructing URLs used
+# in emails.
+site_url = "http://localhost:3000"
+# A list of *exact* URLs that auth providers are permitted to redirect to post authentication.
+additional_redirect_urls = ["https://localhost:3000"]
+# How long tokens are valid for, in seconds. Defaults to 3600 (1 hour), maximum 604,800 seconds (one
+# week).
+jwt_expiry = 3600
+# Allow/disallow new user signups to your project.
+enable_signup = true
+
+[auth.email]
+# Allow/disallow new user signups via email to your project.
+enable_signup = true
+# If enabled, a user will be required to confirm any email change on both the old, and new email
+# addresses. If disabled, only the new email is required to confirm.
+double_confirm_changes = true
+# If enabled, users need to confirm their email address before signing in.
+enable_confirmations = false
+
+# Use an external OAuth provider. The full list of providers are: `apple`, `azure`, `bitbucket`,
+# `discord`, `facebook`, `github`, `gitlab`, `google`, `keycloak`, `linkedin`, `notion`, `twitch`,
+# `twitter`, `slack`, `spotify`, `workos`, `zoom`.
+[auth.external.apple]
+enabled = false
+client_id = ""
+secret = ""
+# Overrides the default auth redirectUrl.
+redirect_uri = ""
+# Overrides the default auth provider URL. Used to support self-hosted gitlab, single-tenant Azure,
+# or any other third-party OIDC providers.
+url = ""
+
+[analytics]
+enabled = false
+port = 54327
+vector_port = 54328
+# Setup BigQuery project to enable log viewer on local development stack.
+# See: https://supabase.com/docs/guides/getting-started/local-development#enabling-local-logging
+gcp_project_id = ""
+gcp_project_number = ""
+gcp_jwt_path = "supabase/gcloud.json"