3.0.0

tzhf · Apr 8, 2024 · 08a24cc · 08a24cc
1 parent 2481564
commit 08a24cc
Show file tree

Hide file tree

Showing 452 changed files with 18,571 additions and 19,357 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
diff --git a/.env.example b/.env.example
@@ -1,6 +1,5 @@
-CG_PUBLIC_URL=chatguessr.com
-CG_API_URL=https://chatguessr.com/api
-SOCKET_SERVER_URL=<SOCKET_SERVER_URL>
-SUPABASE_URL=<SUPABASE_URL>
-SUPABASE_ANON_KEY=<SUPABASE_ANON_KEY>
-NODE_ENV=<development|production>
+VITE_CG_PUBLIC_URL=chatguessr.com
+VITE_CG_API_URL=https://chatguessr.com/api
+VITE_SOCKET_SERVER_URL=<SOCKET_SERVER_URL>
+VITE_SUPABASE_URL=<SUPABASE_URL>
+VITE_SUPABASE_ANON_KEY=<SUPABASE_ANON_KEY>
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,26 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "es6": true,
+    "node": true
+  },
+  "plugins": ["vue", "@typescript-eslint", "prettier"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+    "plugin:vue/vue3-recommended",
+    "@vue/eslint-config-typescript/recommended",
+    "@vue/eslint-config-prettier"
+  ],
+  "rules": {
+    "no-empty": ["error", { "allowEmptyCatch": true }],
+    "@typescript-eslint/no-empty-function": ["error", { "allow": ["arrowFunctions"] }],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "vue/multi-word-component-names": "off",
+    "vue/no-v-html": "off"
+  }
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,17 +2,24 @@ name: CI
 
 on: [push, pull_request]
 
+env:
+  VITE_CG_PUBLIC_URL: ${{secrets.VITE_CG_PUBLIC_URL}}
+  VITE_CG_API_URL: ${{secrets.VITE_CG_API_URL}}
+  VITE_SOCKET_SERVER_URL: ${{secrets.VITE_SOCKET_SERVER_URL}}
+  VITE_SUPABASE_URL: ${{secrets.VITE_SUPABASE_URL}}
+  VITE_SUPABASE_ANON_KEY: ${{secrets.VITE_SUPABASE_ANON_KEY}}
+
 jobs:
   types:
     name: Types
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - name: Install dependencies
         run: npm ci
       - name: Check types
@@ -22,45 +29,43 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - name: Install dependencies
         run: npm ci
       - name: Run tests
         run: npm test
   package:
     name: Package
-    needs: [test, types]
+    needs: [types, test]
     strategy:
       fail-fast: false
       matrix:
         os: [windows-latest, macos-latest, ubuntu-latest]
     runs-on: ${{matrix.os}}
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - name: Install dependencies
         run: npm ci
-      - name: Write .env
-        run: node create-env.js
-        env:
-          CG_PUBLIC_URL: ${{secrets.CG_PUBLIC_URL}}
-          CG_API_URL: ${{secrets.CG_API_URL}}
-          SOCKET_SERVER_URL: ${{secrets.SOCKET_SERVER_URL}}
-          SENTRY_DSN: ${{secrets.SENTRY_DSN}}
-          SUPABASE_URL: ${{secrets.SUPABASE_URL}}
-          SUPABASE_ANON_KEY: ${{secrets.SUPABASE_ANON_KEY}}
-          TWITCH_CLIENT_ID: ${{secrets.TWITCH_CLIENT_ID}}
+      # - name: Write .env
+      #   run: node create-env.js
+        # env:
+        #   VITE_CG_PUBLIC_URL: ${{secrets.VITE_CG_PUBLIC_URL}}
+        #   VITE_CG_API_URL: ${{secrets.VITE_CG_API_URL}}
+        #   VITE_SOCKET_SERVER_URL: ${{secrets.VITE_SOCKET_SERVER_URL}}
+        #   VITE_SUPABASE_URL: ${{secrets.VITE_SUPABASE_URL}}
+        #   VITE_SUPABASE_ANON_KEY: ${{secrets.VITE_SUPABASE_ANON_KEY}}
       - name: Package
         run: npm run package
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: Chatguessr-${{runner.os}}
           path: out/*/
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -5,6 +5,13 @@ on:
   release:
     types: [created]
 
+env:
+  VITE_CG_PUBLIC_URL: ${{secrets.VITE_CG_PUBLIC_URL}}
+  VITE_CG_API_URL: ${{secrets.VITE_CG_API_URL}}
+  VITE_SOCKET_SERVER_URL: ${{secrets.VITE_SOCKET_SERVER_URL}}
+  VITE_SUPABASE_URL: ${{secrets.VITE_SUPABASE_URL}}
+  VITE_SUPABASE_ANON_KEY: ${{secrets.VITE_SUPABASE_ANON_KEY}}
+
 jobs:
   release:
     name: Publish release
@@ -15,29 +22,26 @@ jobs:
     runs-on: ${{matrix.os}}
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - name: Install dependencies
         run: npm ci
-      - name: Write .env
-        run: node create-env.js
-        env:
-          CG_PUBLIC_URL: ${{secrets.CG_PUBLIC_URL}}
-          CG_API_URL: ${{secrets.CG_API_URL}}
-          SOCKET_SERVER_URL: ${{secrets.SOCKET_SERVER_URL}}
-          SENTRY_DSN: ${{secrets.SENTRY_DSN}}
-          SUPABASE_URL: ${{secrets.SUPABASE_URL}}
-          SUPABASE_ANON_KEY: ${{secrets.SUPABASE_ANON_KEY}}
-          TWITCH_CLIENT_ID: ${{secrets.TWITCH_CLIENT_ID}}
+      # - name: Write .env
+      #   run: node create-env.js
+      #   env:
+      #     VITE_CG_PUBLIC_URL: ${{secrets.VITE_CG_PUBLIC_URL}}
+      #     VITE_CG_API_URL: ${{secrets.VITE_CG_API_URL}}
+      #     VITE_SOCKET_SERVER_URL: ${{secrets.VITE_SOCKET_SERVER_URL}}
+      #     VITE_SUPABASE_URL: ${{secrets.VITE_SUPABASE_URL}}
+      #     VITE_SUPABASE_ANON_KEY: ${{secrets.VITE_SUPABASE_ANON_KEY}}
       - name: Publish
         run: npm run publish
         env:
           GITHUB_TOKEN: ${{github.token}}
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: Chatguessr-${{runner.os}}
           path: out/*/
-
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 node_modules
+.vite
+out
 dist
+*.log*
 .env
-.parcel-cache
-out/
diff --git a/.prettierrc.yaml b/.prettierrc.yaml
@@ -0,0 +1,5 @@
+singleQuote: true
+semi: false
+printWidth: 100
+trailingComma: none
+endOfLine: auto
diff --git a/README.md b/README.md
@@ -1,36 +1,56 @@
-# ChatGuessr
-
-> Play GeoGuessr on Stream with Twitch Chat.
-
-This is the source code for the ChatGuessr application. Are you a streamers or player? Check [the website](https://chatguessr.com) instead.
+<div align="center">
+  <img src="./build/icon.png" style="width:40px">
+  <h1>ChatGuessr</h1>
+</div>
+
+<p align="center">
+  <a href="https://github.com/tzhf/chatguessr/releases">
+     <img alt="releases url" src="https://img.shields.io/github/v/release/tzhf/chatguessr?style=for-the-badge&labelColor=1C1E26&color=61ffca"/>
+  </a>
+  <a href="https://github.com/tzhf/chatguessr/blob/main/LICENSE">
+    <img alt="license url" src="https://img.shields.io/badge/license%20-MIT-1C1E26?style=for-the-badge&labelColor=1C1E26&color=61ffca"/>
+  </a>
+  <a href="https://paypal.me/chatguessr">
+    <img alt="paypal url" src="https://img.shields.io/badge/support%20on-paypal-1C1E26?style=for-the-badge&labelColor=1C1E26&color=B181F1"/>
+  </a>
+</p>
+
+<p align=center>This is the source code for the ChatGuessr application. Are you a streamer or a player ? Check <a href="https://chatguessr.com">the website</a> instead.</span></p>
 
 ## Build
+
 Run the application in development mode:
+
 ```
-npm start
+npm run dev
 ```
 
 Run unit tests:
+
 ```
 npm test
 ```
 
-Typecheck JSDoc:
+Typecheck
+
 ```
 npm run typecheck
 ```
 
-Build the application for the current platform:
+Lint
+
 ```
-npm run package
+npm run lint
 ```
 
-Build an installer for the current platform:
+Format
+
 ```
-npm run make
+npm run format
 ```
 
 ## License
+
 The ChatGuessr source is available under the [MIT License](./LICENSE).
 
-The Montserrat and Comfortaa fonts are used under the [Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL).
+The Montserrat font is used under the [Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL).
diff --git a/assets/extenssr-styles.css b/assets/extenssr-styles.css
diff --git a/assets/flags/USME.svg b/assets/flags/USME.svg
diff --git a/assets/flags/USMT.svg b/assets/flags/USMT.svg
diff --git a/assets/flags/USVT.svg b/assets/flags/USVT.svg
diff --git a/assets/fonts/Comfortaa-Bold.ttf b/assets/fonts/Comfortaa-Bold.ttf
diff --git a/assets/fonts/Comfortaa-Regular.ttf b/assets/fonts/Comfortaa-Regular.ttf
diff --git a/assets/fonts/montserrat-regular-webfont.woff b/assets/fonts/montserrat-regular-webfont.woff
diff --git a/assets/icons/gear.svg b/assets/icons/gear.svg
diff --git a/assets/icons/scoreboard_hidden.svg b/assets/icons/scoreboard_hidden.svg
diff --git a/assets/icons/scoreboard_visible.svg b/assets/icons/scoreboard_visible.svg
diff --git a/assets/icons/start_flag.svg b/assets/icons/start_flag.svg
diff --git a/assets/icons/timer_hidden.svg b/assets/icons/timer_hidden.svg
diff --git a/assets/icons/timer_visible.svg b/assets/icons/timer_visible.svg