Solid Start + UX improvements

packages/app/.env.example → .env.example

@@ -14,12 +14,12 @@
 # Change the query params at the end of the URL to "?ssl={"rejectUnauthorized":true}"
 DATABASE_URL='mysql://YOUR_MYSQL_URL_HERE?ssl={"rejectUnauthorized":true}'
 
-# Next Auth
+# Auth
 # You can generate a new secret on the command line with:
 # openssl rand -base64 32
 # https://next-auth.js.org/configuration/options#secret
-# NEXTAUTH_SECRET=""
-NEXTAUTH_URL="http://localhost:3000"
+# AUTH_SECRET=""
+AUTH_URL="http://localhost:3000"
 
 # Next Auth Discord Provider
 DISCORD_CLIENT_ID=""
@@ -46,4 +46,8 @@ EMAIL_SERVER_PASSWORD=
 EMAIL_FROM=
 
 # aggregation pipeline
-FILE_DOWNLOAD_PATH=/dev/null
+FILE_DOWNLOAD_PATH=/dev/null
+
+
+# compat api (used by old hkviz versions)
+COMPAT_API_KEY=abc

.github/workflows/ci.yml

@@ -0,0 +1,104 @@
+name: CI
+
+on:
+    push:
+        branches: ['*']
+    # pull_request:
+    #   branches: [ '*' ]
+
+jobs:
+    tests:
+        name: Run Tests
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '20'
+
+            - name: Setup pnpm
+              uses: pnpm/action-setup@v2
+              with:
+                  version: 9
+
+            - name: Cache pnpm store
+              uses: actions/cache@v3
+              with:
+                  path: ~/.pnpm-store
+                  key: ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-
+
+            - name: Install dependencies
+              run: pnpm install
+
+            - name: Run Vitest
+              run: pnpm run test
+
+    typecheck:
+        name: TypeScript Check
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '20'
+
+            - name: Setup pnpm
+              uses: pnpm/action-setup@v2
+              with:
+                  version: 9
+
+            - name: Cache pnpm store
+              uses: actions/cache@v3
+              with:
+                  path: ~/.pnpm-store
+                  key: ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-
+
+            - name: Install dependencies
+              run: pnpm install
+
+            - name: Run TypeScript Check
+              run: pnpm run typecheck
+
+    lint:
+        name: Lint Code
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '20'
+
+            - name: Setup pnpm
+              uses: pnpm/action-setup@v2
+              with:
+                  version: 9
+
+            - name: Cache pnpm store
+              uses: actions/cache@v3
+              with:
+                  path: ~/.pnpm-store
+                  key: ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-
+
+            - name: Install dependencies
+              run: pnpm install
+
+            - name: Run Linter
+              run: pnpm run lint

.gitignore

@@ -1,48 +1,33 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-# dependencies
-node_modules
-/.pnp
-.pnp.js
-
-# testing
-coverage
-
-# database
-prisma/db.sqlite
-prisma/db.sqlite-journal
-
-# next.js
-.next/
-out/
-next-env.d.ts
-
-# production
-build
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-.pnpm-debug.log*
+dist
+.solid
+.output
+.vercel
+.netlify
+.vinxi
+app.config.timestamp_*.js
 
-# local env files
-# do not commit any .env files to git, except for the .env.example file. https://create.t3.gg/en/usage/env-variables#using-environment-variables
+# Environment
 .env
 .env*.local
 
-# vercel
-.vercel
+# dependencies
+/node_modules
 
-# typescript
-*.tsbuildinfo
+# IDEs and editors
+/.idea
+.project
+.classpath
+*.launch
+.settings/
 
-dist
+# Temp
+gitignore
 
-**/.tsup
+# System Files
+.DS_Store
+Thumbs.db
+.assetpack
 
-**/tsup.config.bundled_*.mjs
+# Generated via assetpack build
+public/assets

.prettierrc

@@ -0,0 +1,11 @@
+{
+    "trailingComma": "all",
+    "tabWidth": 4,
+    "printWidth": 120,
+    "useTabs": true,
+    "semi": true,
+    "singleQuote": true,
+    "plugins": ["prettier-plugin-tailwindcss"],
+    "tailwindFunctions": ["cn"],
+    "tailwindAttributes": ["iconClassName", "textClassName"]
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "always"
+	}
+}

README.md

@@ -20,7 +20,7 @@ Feel free to [open an issue](https://github.com/hkviz/hkviz-web/issues) on this
 
 To get started recording your own gameplay analytics visit [hkviz.org](https://www.hkviz.org).
 
-You can also view gameplays from other players, if they send you a link and have set their gameplay to 'public' or 'unlisted' or by visting the
+You can also view gameplays from other players, if they send you a link and have set their gameplay to 'public' or 'unlisted' or by visiting the
 [public gameplays page](https://www.hkviz.org/run).
 
 ## For developers
@@ -37,9 +37,9 @@ To set this project up locally:
 
 This project is a monorepo, with the following packages:
 
--   `@hkviz/hk-data`: A package containing extracted data from Hollow Knight. It mainly exists so the other packages can be licensed under MIT, while this package contains copyrighted data.
--   `@hkviz/parser`: A package for parsing the recording files created by the mod
--   `@hkviz/app`: The frontend of the project, currently a Next.js app
+-   `src/lib/hk-data`: Contains extracted data from Hollow Knight. (Not licensed under MIT)
+-   `src/lib/parser`: Parsing the recording files created by the mod
+-   `src/routes`: standard solid start folder for routes
 
 ### License