Suggestion Form

.env.example

@@ -1,4 +1,6 @@
 DB_URL = file:database/local.db          # location of local database
 DB_AUTH_TOKEN =                          # you can leave this empty for local development
 DB_VISITS_AUTH_TOKEN =                   # you can leave this empty for local development
-DB_VISITS_URL = file:database/visits.db  # location of local database with site visits
+DB_VISITS_URL = file:database/visits.db  # location of local database with site visits
+GITHUB_PRIVATE_KEY =                     # you can leave this empty for local development
+REDIS_URL =                              # you can leave this empty for local development

.github/workflows/_deploy-reusable.yaml

@@ -22,6 +22,10 @@ on:
                 required: true
             DB_VISITS_AUTH_TOKEN:
                 required: true
+            _GITHUB_PRIVATE_KEY:
+                required: true
+            REDIS_URL:
+                required: true
 
 jobs:
     build-and-deploy:
@@ -66,6 +70,8 @@ jobs:
                   DB_AUTH_TOKEN: ${{ secrets.DB_AUTH_TOKEN }}
                   DB_VISITS_URL: ${{ secrets.DB_VISITS_URL }}
                   DB_VISITS_AUTH_TOKEN: ${{ secrets.DB_VISITS_AUTH_TOKEN }}
+                  GITHUB_PRIVATE_KEY: ${{ secrets._GITHUB_PRIVATE_KEY }}
+                  REDIS_URL: ${{ secrets.REDIS_URL }}
               run: pnpm build
 
             - name: Get latest commit message

.github/workflows/deploy-preview-skip-db.yaml

@@ -17,3 +17,5 @@ jobs:
             NETLIFY_ACCESS_TOKEN: ${{ secrets.NETLIFY_ACCESS_TOKEN }}
             DB_VISITS_URL: ${{ secrets.DB_VISITS_URL }}
             DB_VISITS_AUTH_TOKEN: ${{ secrets.DB_VISITS_AUTH_TOKEN }}
+            _GITHUB_PRIVATE_KEY: ${{ secrets._GITHUB_PRIVATE_KEY }}
+            REDIS_URL: ${{ secrets.REDIS_URL }}

.github/workflows/deploy-preview.yaml

@@ -17,3 +17,5 @@ jobs:
             NETLIFY_ACCESS_TOKEN: ${{ secrets.NETLIFY_ACCESS_TOKEN }}
             DB_VISITS_URL: ${{ secrets.DB_VISITS_URL }}
             DB_VISITS_AUTH_TOKEN: ${{ secrets.DB_VISITS_AUTH_TOKEN }}
+            _GITHUB_PRIVATE_KEY: ${{ secrets._GITHUB_PRIVATE_KEY }}
+            REDIS_URL: ${{ secrets.REDIS_URL }}

.github/workflows/deploy-prod-skip-db.yaml

@@ -17,3 +17,5 @@ jobs:
             NETLIFY_ACCESS_TOKEN: ${{ secrets.NETLIFY_ACCESS_TOKEN }}
             DB_VISITS_URL: ${{ secrets.DB_VISITS_URL }}
             DB_VISITS_AUTH_TOKEN: ${{ secrets.DB_VISITS_AUTH_TOKEN }}
+            _GITHUB_PRIVATE_KEY: ${{ secrets._GITHUB_PRIVATE_KEY }}
+            REDIS_URL: ${{ secrets.REDIS_URL }}

.github/workflows/deploy-prod.yaml

@@ -17,3 +17,5 @@ jobs:
             NETLIFY_ACCESS_TOKEN: ${{ secrets.NETLIFY_ACCESS_TOKEN }}
             DB_VISITS_URL: ${{ secrets.DB_VISITS_URL }}
             DB_VISITS_AUTH_TOKEN: ${{ secrets.DB_VISITS_AUTH_TOKEN }}
+            _GITHUB_PRIVATE_KEY: ${{ secrets._GITHUB_PRIVATE_KEY }}
+            REDIS_URL: ${{ secrets.REDIS_URL }}

CONTRIBUTING.md

@@ -2,17 +2,15 @@
 
 There are three ways to contribute:
 
-- [Submit Our Google Form](#option-1-submit-our-google-form)
+- [Use the Suggestion Form](#option-1-use-the-suggestion-form)
 - [Create a Pull Request](#option-2-create-a-pull-request)
 - [Create an Issue](#option-3-create-an-issue)
 
-## Option 1: Submit our Google Form
+## Option 1: Use the Suggestion Form
 
-The Google Form is the least technical way to submit new categories, properties, and implications. Issues and feature requests can also be submitted. This option does not require any knowledge of GitHub or coding, making it accessible to everyone.
+On most pages of CatDat, you will find a suggestion form at the bottom. Use it to contribute new data, report an issue, or make a suggestion. After submission, the form automatically creates a GitHub issue, which we then review and try to resolve and implement.
 
-[**Link to the Google Form**](https://forms.gle/8LBmro5FfSa43pD2A)
-
-We will then review your submission and try to implement it.
+This option does not require any knowledge of GitHub or coding, making it accessible to everyone. It also does not require following any guidelines for adding new data (see below).
 
 ## Option 2: Create a Pull Request
 
@@ -110,3 +108,7 @@ When contributing new data (categories, functors, properties, implications), ple
 ## Option 3: Create an Issue
 
 If you want to report a bug or submit a feature request, you can [**create an issue**](https://github.com/ScriptRaccoon/CatDat/issues/new). You will need a GitHub account for this.
+
+## Deprecated Options
+
+Before the Suggestion Form (Option 1) was introduced, you could use a [Google Form](https://forms.gle/8LBmro5FfSa43pD2A). It is deprecated and will be removed soon.

package.json

@@ -47,9 +47,12 @@
 		"@fortawesome/free-regular-svg-icons": "^7.2.0",
 		"@fortawesome/free-solid-svg-icons": "^7.2.0",
 		"@libsql/client": "^0.17.2",
+		"@octokit/app": "^16.1.2",
 		"chart.js": "^4.5.1",
 		"es6-crawler-detect": "^4.0.2",
+		"ioredis": "^5.10.1",
 		"katex": "^0.16.44",
+		"leo-profanity": "^1.9.0",
 		"sql-template-tag": "^5.2.1",
 		"svelte-chartjs": "^4.0.1",
 		"svelte-fa": "^4.0.4"