Rewrite with sidebase

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[**.{json,js,ts,y{a,}ml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 4

.github/workflows/ci.yaml

@@ -0,0 +1,26 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 16.14.2
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.14.2
+      - run: npm ci
+        working-directory: ./app
+      - run: npm run build
+        working-directory: ./app
+      - run: npm run lint
+        working-directory: ./app
+      - run: npm run test
+        working-directory: ./app

.gitignore

@@ -1,30 +1,78 @@
-# mac
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+/logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# OS generated files #
+######################
 .DS_Store
-.vscode
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# helmsman generated tmp folder
+.helmsman-tmp
+
+# Coverage directory used by tools like istanbul
+coverage
 
-# dependencies
-node_modules
+# Dependency directories
+node_modules/
+jspm_packages/
 
-# eslint
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
 .eslintcache
 
-# logs
-npm-debug.log
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
 
-# Nuxt build
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
 .nuxt
+.output
 
 # Nuxt generate
 dist
 
-# VS Code
-.editorconfig
+# Histoire output
+.histoire
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+# IDE / Editor
+.idea
 
-# python
-__pycache__
-Pipfile
-.coverage
+# Service worker
+sw.*
 
-# suggestions
-suggestions
-suggestions.log
+# Vim swap files
+*.swp

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "dbaeumer.vscode-eslint",
+    "vue.volar"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[js]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[ts]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "eslint.validate": [
+    "javascript",
+    "typescript",
+    "vue"
+  ]
+}

README.md

@@ -1,8 +1,10 @@
+![isthisanmlm](./.github/webpage.png)
+
 # is-this-an-mlm
 
-Website to determine whether a company is an mlm. It currently runs [here](https://isthisanmlm.com) and is referenced by multiple websites, videos and people as a help to determine whether a company is a multilevel marketing (MLM) company.
+This website determines whether a company is an mlm. It currently runs [here](https://isthisanmlm.com) and is referenced by multiple websites, videos and people as a help to determine whether a company is a multilevel marketing (MLM) company.
 
-Multilevel marketing companies often prey on their members. I decided to create this site as a help for the community in order to tackle these harmful schemes. It is developed out in the open to keep it open and transparent.
+`Multilevel marketing companies` often prey on their members. I decided to create this site as a help for the community in order to tackle these harmful schemes. It is developed out in the open to keep it open and transparent.
 
 The main source of MLMs is the `antiMLM` reddit community and the visitors of the page themselves (as they can submit companies by themselves).
 
@@ -15,4 +17,6 @@ Install `docker` and `docker-compose`. Then run:
 
 ## Development
 
-For development instructions, please have a look at the `README.md`s in each individual service directory.
+This website is build with [SideBase](https://github.com/sidestream-tech/sidebase) and following the basic stacks of SideBase.
+
+For development instructions, please have a look at the [`README.md`](/app/README.md).

app/.dockerignore

@@ -0,0 +1,7 @@
+node_modules
+npm-debug*
+.nuxt
+dist
+tests
+.histoire
+.output

app/.eslintignore

@@ -0,0 +1,6 @@
+dist
+public
+
+# ignore generate imports
+auto-imports.d.ts
+components.d.ts

app/.eslintrc

@@ -0,0 +1,26 @@
+{
+    "extends": "@antfu/vue",
+    "overrides": [
+        {
+            "files": [
+                "./server/**/*.ts"
+            ],
+            "rules": {
+                "no-console": "off",
+                "no-undef": "error"
+            }
+        }
+    ],
+    "rules": {
+        "curly": [
+            "error",
+            "all"
+        ],
+        "brace-style": "off",
+        "@typescript-eslint/brace-style": [
+            "error",
+            "1tbs"
+        ],
+        "no-unused-vars": "error"
+    }
+}

app/.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Check types
+npm run lint:types
+
+# Lint and fix staged files (e.g.: fix the import order of a file and still commit it afterwards)
+npx lint-staged

app/.npmrc

@@ -0,0 +1,4 @@
+# Required to install nuxt3 at the moment, see https://v3.nuxtjs.org/getting-started/installation#new-project (select `pnpm`)
+shamefully-hoist=true
+# Required to enforce the engine versions we provide in the `package.json`
+engine-strict=true

app/.nvmrc

@@ -0,0 +1 @@
+16.14.2

app/Dockerfile

@@ -0,0 +1,37 @@
+# see https://docs.docker.com/engine/reference/builder/#understand-how-arg-and-from-interact
+ARG NODE_VERSION=node:16.14.2
+
+FROM $NODE_VERSION AS dependency-base
+
+# create destination directory
+RUN mkdir -p /app
+WORKDIR /app
+
+# copy the app, note .dockerignore
+COPY package.json .
+COPY package-lock.json .
+RUN npm ci
+
+FROM dependency-base AS production-base
+
+# build will also take care of building
+# if necessary
+COPY . .
+RUN npm run build
+
+FROM $NODE_VERSION-slim AS production
+
+COPY --from=production-base /app/.output /app/.output
+
+# Service hostname
+ENV NUXT_HOST=0.0.0.0
+
+# Service version
+ARG NUXT_APP_VERSION
+ENV NUXT_APP_VERSION=${NUXT_APP_VERSION}
+
+# Run in production mode
+ENV NODE_ENV=production
+
+# start the app
+CMD [ "node", "/app/.output/server/index.mjs" ]

app/README.md

@@ -0,0 +1,107 @@
+# App
+
+This is a project starter for your Nuxt 3 + Typescript application. This starter is meant to help you to start new projects, Nuxt 3 is a frontend + backend ("fullstack") framework that natively enforces typed JavaScript ("TypeScript"). Nuxt 3 is based on Vue 3.
+
+This starter has the following features:
+- slim docker ready
+    ```sh
+    > docker build -t nuxt3-app .
+    > docker run -p 3000:3000 --init --rm nuxt3-app
+    ```
+    - Note: Docker is not required for development or deployment - for development `sqlite3` is used and will launch automatically via `npm run dev` 🚀
+- Component stories via `Histoire`:
+    ```sh
+    > npm i
+    > npm run story
+    ```
+- Linting & Formatting (`npm run lint`)
+    - `npm run lint:style`: eslint for formatting & linting
+        - `npm run lint:style -- --fix`: Autofix styles and lints where possible
+    - `npm run lint:types`: typescript typechecking
+- Testing & Code Coverage & Component Snapshots
+    - `npm run test`: Run tests once, report results and coverage
+        - `npm run test:watch`: Run tests and watch file changes, run tests for changed files
+        - `npm run test -- -u`: Update component snapshots after components changed
+        - `npm run test -- -t "some test-text"`: Run all tests with `some test-text` in their `test(...)` description
+    - `@testing-library/vue` for easy and best-practice component tests, [see example here](https://testing-library.com/docs/vue-testing-library/examples)
+    - breakpoint debugging in VS Code
+- CSS usable without imports
+    - Utility & Styling: TailwindCSS 3
+    - Components: Ant Design Vue with component-auto-import
+- Miscallaneous
+    - Pre-commit checking (husky) & fixing (lint-staged)
+    - github CI pipeline to linting, testing, typing checks
+    - nuxt-component support in tests and histoire
+    - debug sql database queries by setting `logging: true` in the `database/index.ts`: This will show you a live log of all ongoing database queries which is super helpful to debug database problems
+
+## Local Setup
+
+If this is not the first time you use `npm` / `node` v16 on your setup:
+```sh
+> npm i
+
+# development mode with hot reloading
+> npm run dev
+
+# component based development via histoire
+> npm run story
+
+# testing via vitest
+> npm run test
+> npm run test:watch  # watch tests
+
+# run a specific test by text
+> npm run test -- -t "text of test"
+
+# update html screenshots of components
+> npm run test -- -u
+
+# linting & type checks
+> npm run lint
+> npm run lint -- --fix  # autofix lints
+
+# breakpoint debugging (zero-config in VS Code)
+# 1. Open the command palette (CMD / CTRL + SHIFT + P)
+# 2. Select "Debug: JavaScript Debug Terminal"
+# 3. Run any `npm` command inside `app/`, e.g.: `npm run test`
+# 4. Your code editor colors should change a bit (e.g.: to orange) while executing the command, the left side should show deep execution insights
+# 5. Set breakpoints (click left of line count in editor - red dot should appear) - the debugger will automatically work and stop at them and allow you to inspect variables
+> npm run test  # also works for more specific tests via `-t` option (see above)
+```
+
+### First time setup
+
+If this is the first time you run a `npm` / `node` app on your setup:
+
+1. Install the `node` version manager `nvm` by running:
+    ```sh
+    > curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+    ```
+2. Install the required `node` and `npm` version:
+    ```sh
+    # uses `.nvmrc` to install required version
+    > nvm install
+    ```
+3. Use the required `node` and `npm` version:
+    ```sh
+    # uses `.nvmrc` to use required version
+    > nvm use
+
+    # ALTERNATIVE: make node 16.14.2 your default node version (version copied from `.nvmrc`, check there for most up to date node version)
+    > nvm alias default 16.14.2
+    ```
+4. Install a code editor (recommended: VS Code), [get it here](https://code.visualstudio.com/)
+5. Uninstall or disable the old Vue VS Code extension `Vetur`, else conflicts may arise between `volar` and `Vetur`
+6. Install the `volar` extension to support `vue`, `nuxt` and `typescript` development help
+    - for vs code: https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar
+    - sublime LSP: https://github.com/sublimelsp/LSP-volar
+    - vim: https://github.com/yaegassy/coc-volar
+7. Enable "take over mode" for volar for this project.
+    - documented here: https://github.com/johnsoncodehk/volar/discussions/471
+    - for VS Code:
+        1. Run (CMD/CTRL + SHIFT + P): Extensions: Show Built-in Extensions
+        2. Find "TypeScript and JavaScript Language Features"
+        3. Right click and select "disable for workspace"
+        4. Reload the editor
+        5. A message "Take over mode enabled" (or similar) should appear
+8. Go to the [top of this section](#local-setup) and execute commands