Optimize category filtering performance by improving caching mechanism

.github/workflows/ci_cd.yml

@@ -6,43 +6,68 @@ on:
       - main
 
 jobs:
-  confirm-changes:
-    name: confirm there are changes in the backend
+  deploy-backend:
+    name: deploy backend to tiptops server
     runs-on: ubuntu-latest
-    outputs:
-      folder_changed: ${{ steps.check_files.outputs.folder_changed }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Execute remote ssh commands using passwords
+        uses: appleboy/ssh-action@v1
         with:
-          fetch-depth: 2
-
-      - name: Find name of changes files with git
-        id: check_files
-        run: |
-          set +e
-          CHANGED_FILES=$(git diff --name-only ${{github.event.before}} ${{github.sha}} || true)
-          echo "changed files found: $CHANGED_FILES"
-
-          CHANGED_COUNT=$(echo "$CHANGED_FILES" | grep -c "backend")
+          host: ${{secrets.HOST}}
+          username: ${{secrets.USERNAME}}
+          password: ${{secrets.PASSWORD}}
+          port: ${{secrets.PORT}}
 
-          set -e
-          echo "file count that was changed: $CHANGED_COUNT"
+          script: |
+            echo "Starting deployment process"
+            # NOTE: Use 'sh' to avoid issues with inline script quoting
+            sudo -S bash -c '
+              cd /root/docker/csphere
+              #run the deployment script 
+              ./build-csphere-backend.sh
+              echo "deployment was a success"
+            ' <<< "${{secrets.PASSWORD}}"
 
-          if [ "$CHANGED_COUNT" -gt 0 ]; then
-            echo "folder_changed=true" >> $GITHUB_OUTPUT
+      - name: Slack Notification
+        if: always()
+        run: |
+          if [[ "${{ job.status }}" == "success" ]]; then
+            STATUS_TEXT="Deployment Successful"
+            COLOR="#098824"
           else
-            echo "folder_changed=false" >> $GITHUB_OUTPUT
+            STATUS_TEXT="Deployment Failed"
+            COLOR="#a80a0a"
           fi
 
-  deploy-backend:
-    name: deploy backend to tiptops server
-    runs-on: ubuntu-latest
-    # needs: confirm-changes
+          REPO_URL="https://github.com/${{ github.repository }}"
+          RUN_URL="$REPO_URL/actions/runs/${{ github.run_id }}"
+          COMMIT_URL="$REPO_URL/commit/${{ github.sha }}"
+
+          curl -X POST -H 'Content-type: application/json; charset=utf-8' \
+          -H "Authorization: Bearer ${{ secrets.SLACK_TOKEN }}" \
+          --data "{
+            \"channel\": \"${{ secrets.SLACK_CHANNEL }}\",
+            \"attachments\": [
+              {
+                \"color\": \"$COLOR\",
+                \"title\": \"Csphere CI/CD Update - Backend\",
+                \"title_link\": \"$RUN_URL\",
+                \"text\": \"$STATUS_TEXT\n\n*Repository:* ${{ github.repository }}\n*Branch:* \`${{ github.ref_name }}\` \n*Commit:* <$COMMIT_URL|${{ github.event.head_commit.message }}>\n*Author:* ${{ github.actor }}\",
+                \"footer\": \"GitHub Actions • Build #${{ github.run_number }}\",
+                \"ts\": $(date +%s)
+              }
+            ]
+          }" \
+          https://slack.com/api/chat.postMessage
+
+  deploy-worker:
+    name: deploy worker to the backend servers
+    runs-on: ununtu-latest
 
     steps:
-      - name: Execute remote ssh commands using passwords
-        # if: needs.confirm-changes.outputs.folder_changed == 'true'
+      - name: Execute remote ssh commands
         uses: appleboy/ssh-action@v1
+
         with:
           host: ${{secrets.HOST}}
           username: ${{secrets.USERNAME}}
@@ -55,6 +80,38 @@ jobs:
             sudo -S bash -c '
               cd /root/docker/csphere
               #run the deployment script 
-              ./build-csphere-backend.sh
+              ./build-csphere-worker.sh
               echo "deployment was a success"
             ' <<< "${{secrets.PASSWORD}}"
+
+      - name: Slack Notification
+        if: always()
+        run: |
+          if [[ "${{ job.status }}" == "success" ]]; then
+            STATUS_TEXT="Deployment Successful"
+            COLOR="#098824"
+          else
+            STATUS_TEXT="Deployment Failed"
+            COLOR="#a80a0a"
+          fi
+
+          REPO_URL="https://github.com/${{ github.repository }}"
+          RUN_URL="$REPO_URL/actions/runs/${{ github.run_id }}"
+          COMMIT_URL="$REPO_URL/commit/${{ github.sha }}"
+
+          curl -X POST -H 'Content-type: application/json; charset=utf-8' \
+          -H "Authorization: Bearer ${{ secrets.SLACK_TOKEN }}" \
+          --data "{
+            \"channel\": \"${{ secrets.SLACK_CHANNEL }}\",
+            \"attachments\": [
+              {
+                \"color\": \"$COLOR\",
+                \"title\": \"Csphere CI/CD Update - worker\",
+                \"title_link\": \"$RUN_URL\",
+                \"text\": \"$STATUS_TEXT\n\n*Repository:* ${{ github.repository }}\n*Branch:* \`${{ github.ref_name }}\` \n*Commit:* <$COMMIT_URL|${{ github.event.head_commit.message }}>\n*Author:* ${{ github.actor }}\",
+                \"footer\": \"GitHub Actions • Build #${{ github.run_number }}\",
+                \"ts\": $(date +%s)
+              }
+            ]
+          }" \
+          https://slack.com/api/chat.postMessage

README.md

@@ -1,100 +1,146 @@
-<img src="https://github.com/angvit/Content-Rediscovery-Platform/blob/main/frontend/public/cspherelogo2.png?raw=true" alt="logo" width="350" height="200"/>
-
-<h1>Rediscover what matters — faster.</h1>
-
-
-
+<h1 align="center">Csphere</h1>
+
+<p align="center">
+  <a href="https://chromewebstore.google.com/detail/csphere/naacmldkjnlfmhnkbbpppjpmdoiednnn">
+    <img
+      src="https://img.shields.io/badge/Chrome-Install-blue?logo=googlechrome"
+      alt="Install Csphere on Chrome"
+    />
+  </a>
+  &nbsp;&nbsp;
+  <a href="https://addons.mozilla.org/en-US/firefox/addon/csphere">
+    <img
+      src="https://img.shields.io/badge/Firefox-Install-orange?logo=firefoxbrowser"
+      alt="Install Csphere on Firefox"
+    />
+  </a>
+</p>
+
+<hr />
+
+<p>
+  Short for “content sphere”,
+  <a href="https://www.csphere.io/">Csphere.io</a> is a bookmark management application
+  and browser extension that allows users to easily save, search, and organize the
+  web content they consume.
+</p>
+
+<h2>Features</h2>
+
+<ul>
+  <li>Save different forms of web content (e.g. articles, blogs, documentation)</li>
+  <li>Add context via notes, descriptions, and custom keyword tags</li>
+  <li>Organize content using a custom folder structure managed through Csphere’s backend UI</li>
+  <li>
+    Semantically search your content by meaning, time saved, or source
+    <br />
+    <em>(e.g. “Which articles have I read about jet engines this past month?”)</em>
+  </li>
+  <li>Cross-platform access across browsers and mobile devices</li>
+</ul>
+
+<hr />
+
+<h2>Local Setup Guide</h2>
+
+<p>
+  <strong>Note:</strong> This project uses
+  <a href="https://github.com/astral-sh/uv">uv</a> for Python dependency and virtual
+  environment management. All Python commands below assume 
+  <code>uv</code> is installed and active.
+</p>
+
+<h3>1. Backend (Python + FastAPI)</h3>
+
+<pre><code>cd backend
+uv venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+uv pip install -r requirements.txt
+uvicorn app.api.main:app --reload
+</code></pre>
 
-A full-stack web app and browser extension that helps users **save**, **summarize**, and **search** web content using **embeddings** and **ai-generated summaries**. 
 
-**Live App**: [https://www.csphere.io/]
+<h3>2. Frontend (Next.js)</h3>
 
----
+<pre><code>cd frontend
+npm install
+npm run dev
+</code></pre>
 
-# Chrome Extension Download
+<h3>3. Chrome Extension (Local)</h3>
 
-#### 1. Downonload the zipped folder from this link: [download](https://download-directory.github.io/?url=https%3A%2F%2Fgithub.com%2Fcrosve%2FCsphere%2Ftree%2Fmain%2Fchrome_extension)
-#### 2. Extract the folder.
-#### 3. Go to `chrome://extensions/` in Chrome.
-#### 4.  Enable **Developer mode**.
-#### 5. Click **"Load unpacked"** and select the extracted folder.
+<ol>
+  <li>Open <code>chrome://extensions</code></li>
+  <li>Enable <strong>Developer Mode</strong></li>
+  <li>Click <strong>Load Unpacked</strong></li>
+  <li>Select the <code>chrome_extension/</code> folder</li>
+</ol>
 
-## Local Setup
+<hr />
 
-### 1. Backend (Python + FastAPI)
+<h2>Alembic Setup – Database Migrations</h2>
 
-```bash
-cd backend
-python -m venv venv
-source venv/bin/activate (for windows: source venv/scripts/Activate )
-pip install -r requirements.txt
-uvicorn app.api.main:app --reload
-```
+<h3>1. Install Alembic</h3>
 
-API general structure 
-```bash
-/<resource-prefix>/<resource-id>/<sub-resource>?<query-params>
-```
+<pre><code>uv pip install alembic</code></pre>
 
+<h3>2. Initialize Alembic</h3>
 
-### 2. Frontend (Next.js)
+<pre><code>alembic init</code></pre>
 
-```bash
-cd frontend
-npm install
-npm run dev
-```
+<h3>3. Configure <code>alembic.ini</code></h3>
 
-### 3. Chrome Extension
+<p>
+  Set <code>sqlalchemy.url</code> to your PostgreSQL connection string.
+</p>
 
-1. Load the `chrome_extension/` folder into Chrome via `chrome://extensions`
+<h3>4. Set Target Metadata</h3>
 
-2. Enable Developer Mode -> "Load Unpacked" -> Select `chrome_extension/`
+<pre><code>from app.db.base import Base
+target_metadata = Base.metadata
+</code></pre>
 
+<h3>5. Create a Migration</h3>
 
-### Alembic Setup - Database Migrations 
+<pre><code>alembic revision --autogenerate -m "create users table"</code></pre>
 
-1. Install alembic
+<h3>6. Apply Migration</h3>
 
-```bash
-pip install alembic
-```
+<pre><code>alembic upgrade head</code></pre>
 
-2. Initialize Alembic at the root of the backend folder 
+<h3>Downgrade</h3>
 
-```bash
-alembic init
-```
+<pre><code>alembic downgrade -1</code></pre>
 
-3. Configure your alembic INI file
-set your sqlalchemy.url to your postgresql connector string
+<hr />
 
+<h2>Why Csphere?</h2>
 
-4. Set Target Metadata
+<p>
+The problem we identified is for someone who parses thousands of pages of web content daily and experiences trouble locating where this content was consumed, be it on a Chrome or Firefox browser. The user possibly has thousands of web pages already saved in their bookmarks folders and are looking for a more intelligent and context-rich search and storage over their content. 
+</p>
 
-In alembic/env.py, update the target_metadata to use your SQLAlchemy models' metadata.
+<p>
+Install this if you are tired of having thousands of tabs open on your browser, debating if they should be saved with your important bookmarks or not. With Csphere you centralize and take control over the content you consume while organizing your desktop.
+</p>
 
-For example, if you have a Base object defined in app/db/base.py:
+<h2>FAQ</h2>
 
-```bash
-from app.db.base import Base  # Adjust the path based on your project
-target_metadata = Base.metadata
-```
+<h3>How do I pronounce Csphere?</h3>
 
-5. Create a Migration Script
-```bash
-alembic revision --autogenerate -m "create users table"
-```
-6. Apply  your migration to the database
+<p>
+  Csphere is pronounced as "see-sphere".
+</p>
 
-```bash
-alembic upgrade head
-```
+<h3>Can I start using Csphere now? </h3>
 
--To Downgrade a migration run this command
+<p>
+  Visit <a href="https://www.csphere.io/">Csphere.io</a> and download the extension to start using Csphere.
+</p>
 
-```bash
-alembic downgrade -1
-```
+<h3>Is Csphere free?</h3>
 
+<p>
+  Yes, Csphere is 100% free to use.
+</p>