Searchpets release v2

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: openfurs

.github/dependabot.yml

@@ -0,0 +1,28 @@
+version: 2
+
+updates:
+- package-ecosystem: "npm"
+  directory: '/'
+  schedule:
+    interval: weekly
+    time: '00:00'
+  open-pull-requests-limit: 2
+  assignees:
+    - skepfusky
+  commit-message:
+    prefix: fix
+    prefix-development: chore
+    include: scope
+
+- package-ecosystem: "npm"
+  directory: '/app'
+  schedule:
+    interval: weekly
+    time: '00:00'
+  open-pull-requests-limit: 10
+  assignees:
+    - skepfusky
+  commit-message:
+    prefix: fix
+    prefix-development: chore
+    include: scope

.github/workflows/typescript-check.yml

@@ -0,0 +1,29 @@
+name: TS Type Checking
+
+on:
+  push:
+    paths:
+      - "**.ts"
+      - "**.tsx"
+
+jobs:
+  typescript-check:
+    name: TypeScript Type Checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use yarn cache keyed by hashed yarn.lock
+        uses: actions/cache@v2
+        with:
+          path: ~/.yarn
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Checking types
+        run: yarn tsc:lint

.gitignore

@@ -1,5 +1,3 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
 # dependencies
 node_modules
 /.pnp
@@ -37,12 +35,24 @@ node_modules
 # python and database
 venv
 
-# ssl certs
-*.key
-*.crt
-
 # Ignore local Housepets json file
 housepets_db.json
+redis_config.json
 
 # Ignore __pycache__ stuff
-server/__pycache__
+**/__pycache__
+
+# Ignore lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# PWA service workers
+**/sw.js
+**/sw.js.map
+**/workbox-*.js
+**/workbox-*.js.map
+**/worker-*.js
+**/worker-*.js.map
+**/fallback-development.js
+**/fallback-*.js

.husky/common.sh

@@ -0,0 +1,8 @@
+command_exists () {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# Workaround for Windows 10, Git Bash and Yarn
+if command_exists winpty && test -t 1; then
+  exec < /dev/tty
+fi

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+. "$(dirname -- "$0")/common.sh"
+
+git fetch
+git pull

.vscode/searchpets.code-snippets

@@ -0,0 +1,9 @@
+{
+  "Import styles": {
+    "scope": "typescriptreact",
+    "prefix": "importstyles",
+    "body": [
+      "import styles from \"@/styles/$0.module.scss\""
+    ],
+  }
+}

README.md

@@ -1,32 +1,21 @@
 <h1 align="center">
   <img width="128" alt="searchpets-peanut-transparent" src="https://user-images.githubusercontent.com/94678583/170873665-9d07cb32-abb9-45b6-8aea-8e361da84bd7.png">
   <br>
-  Searchpets
+  <em>Searchpets!</em>
 </h1>
 <p align="center">
-  <img src="https://img.shields.io/github/license/OpenFurs/searchpets?style=flat"  alt="GPL 2.0 License"/>
+  <img src="https://img.shields.io/github/license/OpenFurs/searchpets?style=flat" alt="GPL 2.0 License" />
   <img src="https://img.shields.io/github/issues/OpenFurs/searchpets?style=flat" alt="Searchpets' open issues" />
+  <img src="https://img.shields.io/github/last-commit/OpenFurs/searchpets" />
+  <img src="https://img.shields.io/website?label=searchpets.xyz&up_message=up%20and%20running%21&url=https%3A%2F%2Fsearchpets.xyz%2F" />
+  <img src="https://img.shields.io/github/contributors/OpenFurs/searchpets" />
 </p>
 <p align="center">
-Searchpets is an open source search engine to find characters and texts from comics (coming soon) from <i>Housepets!</i> written in Next.js and FastAPI.
+<em>Searchpets!</em> is comic search engine for searching characters, texts from comics, and chapter arcs from the entire <em>Housepets!</em> catalog! Written in Python and TypeScript - it was taken inspiration from this <a href="https://www.housepetscomic.com/forums/viewtopic.php?f=13&t=5434&p=938783&hilit=search+engine#p938783">forum post</a>.
 </p>
 <p align="center">
-This project was taken inspiration from this <a href="https://www.housepetscomic.com/forums/viewtopic.php?f=13&t=5434&p=938783&hilit=search+engine#p938783">forum post</a>.
+  <img src="https://user-images.githubusercontent.com/94678583/188504378-07189cc8-78f1-4020-9878-cae6e4435708.png" alt="Searchpets Dev Demo">
 </p>
-<p align="center">
-  <img src="https://user-images.githubusercontent.com/94678583/163629497-9f5c4921-5a39-4dfe-8729-e56705efb2f7.gif" alt="Searchpets Dev Demo">
-</p>
-
-## Tech stack
-
-![Searchpets Stack](https://skillicons.dev/icons?i=react,nextjs,ts,js,sass,tailwind,py,flask,cloudflare)
-
-The front-end is written in a React framework, Next.js + TypeScript;
-with Tailwind CSS and Sass as CSS painkillers. For the back-end, it's powered
-with Python with the lightweight web framework, Flask.
-
-The website is currently being hosted from a custom Linode server and
-delivered through the interwebs with CloudFlare.
 
 ## Project structure
 
@@ -36,6 +25,16 @@ delivered through the interwebs with CloudFlare.
 - `scripts` - Automated Bash scripts to bulk install Python and Node packages and
   for deployment from the server
 
+## Infrastructure
+
+The front-end is written in Next.js + TypeScript + Lit Web Components;
+with Tailwind CSS. While the back-end is written
+in Python with a lightweight and fast web framework, FastAPI - the
+database is powered by Redis.
+
+The infrastructure is being hosted from Linode and Netlify then
+delivered through the interwebs with Cloudflare.
+
 ## Running the app locally
 
 ### Prerequisites
@@ -53,7 +52,7 @@ To install all the required Node and Python libraries, execute the `setup.sh`
 file.
 
 ```console
-sh scripts/setup.sh
+sh scripts/init.sh
 ```
 
 Once all the libraries have been installed, it will execute `gen.py` to
@@ -64,9 +63,10 @@ concurrently start both Node and Python servers.
 
 ## Disclaimer
 
-The use of third-party content is heavily transformative, and therefore, subject
-of Fair Use. _Housepets!_ and its story and characters is a trademark of Rick Griffin.
+_Searchpets!_ is an open source fan project. SP does not own any of the
+contents used on this website and has no direct affiliation with the entire
+_Housepets!_ web comic or all of Rick Griffin's intellectual property.
 
 ## License
 
-GPT-2.0
+GPL-2.0

app/.env.local.example

@@ -1 +1,2 @@
+REDIS_URL=
 GA=

app/.eslintrc.json

@@ -1,5 +1,5 @@
 {
-  "extends": "next/core-web-vitals",
+  "extends": ["next/core-web-vitals"],
   "rules": {
     "@next/next/no-img-element": "off",
     "react/no-unescaped-entities": "off"

app/.prettierignore

@@ -1,4 +1,3 @@
-next
-out
-build
-coverage
+app/.next
+app/out
+app/build

app/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "none",
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": false,
+  "printWidth": 80
+}

app/@types/app.d.ts

@@ -0,0 +1,61 @@
+declare type ThemeOverrides = "light" | "dark" | "unset"
+
+declare type OptionsCtxTypes = {
+  theme: ThemeOverrides
+  highContrast: boolean
+  expandComics?: boolean
+  animations: boolean | undefined
+  setTheme: (theme: ThemeOverrides) => void
+  setExpandComics?: (expandComics: boolean) => void
+  setHighContrast: (highContrast: boolean) => void
+  setAnimations: (animations: boolean) => void
+}
+
+declare type SidebarCtxTypes = {
+  expanded: boolean
+  marginSize: string
+  setExpanded: (expanded: boolean) => void
+  setMarginSize: (marginSize: string) => void
+}
+
+declare type ModalCtxTypes = {
+  modalOpen: boolean
+  setModalOpen: (modalOpen: boolean) => void
+}
+
+declare interface LayoutProps {
+  children?: React.ReactNode
+}
+
+declare interface ContainerProps extends LayoutProps {
+  title?: string
+  description?: string
+  wrap?: boolean | undefined
+}
+
+declare interface NavLinkProps {
+  link?: string
+  name?: string
+  icon: IconProp
+}
+
+declare interface ComicItemProps {
+  title?: string
+  img: string
+  link: string
+  characters?: string[]
+  guestItem?: boolean
+  favoriteItem?: boolean
+}
+
+declare interface NavbarRootProps extends LayoutProps {}
+
+declare interface SidebarItemProps {
+  link?: string
+  name?: string
+  icon?: any
+  disabled?: boolean
+  header?: string
+  kofi?: boolean
+  hideOnCollapse?: boolean
+}