Merge release 3.1.0 to main

.env.example

@@ -1,3 +1,3 @@
-BASE_URL=https://localhost:7878
-API_SERVER_URL=http://localhost:3000
-WEBSOCKET_SERVER_URL=http://localhost:5555
+VITE_API_SERVER_URL=http://localhost:3000
+VITE_API_VERSION=v1
+VITE_WEBSOCKET_SERVER_URL=http://localhost:5555

.eslintrc.js

@@ -1,23 +1,19 @@
 module.exports = {
+  root: true,
   env: {
     browser: true,
-    es6: true,
     node: true,
+    // https://eslint.vuejs.org/user-guide/#compiler-macros-such-as-defineprops-and-defineemits-generate-no-undef-warnings
+    "vue/setup-compiler-macros": true,
   },
-
-  // the ts-eslint recommended ruleset sets the parser so we need to set it back
-  parser: 'vue-eslint-parser',
-
-  extends: ['plugin:vue/vue3-essential', 'eslint:recommended', 'plugin:prettier/recommended'],
-
+  extends: [
+    "eslint:recommended",
+    "plugin:vue/vue3-recommended",
+    "plugin:prettier/recommended",
+    "prettier",
+  ],
   rules: {
-    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
-    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    // override/add rules settings here, such as:
+    // 'vue/no-unused-vars': 'error'
   },
-
-  overrides: [
-    {
-      files: ['*.js'],
-    },
-  ],
-}
+};

.gitignore

@@ -1,27 +1,69 @@
-.DS_Store
 node_modules
-/dist
+.DS_Store
+dist
+dist-ssr
+*.local
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
 
-# local env files
-.env.local
-.env.*.local
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
 .env
 
-# Log files
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# Nuxt generate
+dist
+
+# vuepress build output
+.vuepress/dist
 
-# Editor directories and files
+# Serverless directories
+.serverless
+
+# IDE / Editor
 .idea
-.vscode
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
-
-# Git
-*.diff
-*.patch
-*.bak
+
+# Service worker
+sw.*
+
+# macOS
+.DS_Store
+
+# Vim swap files
+*.swp

.prettierrc.json

@@ -0,0 +1 @@
+{}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["johnsoncodehk.volar"]
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "editor.formatOnSave": true,
+  "eslint.run": "onSave",
+  "css.lint.unknownAtRules": "ignore",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

README.md

@@ -1 +1,26 @@
-# threads client
+# Threads Client
+
+## Description
+
+This is the Frontend vue app which depends on the [berkmancenter/threads_server](https://github.com/berkmancenter/threads_client) repo to run.
+
+## Installation
+
+- Install and start [berkmancenter/threads_server](https://github.com/berkmancenter/threads_server).
+- Come back to this repo and `yarn install` to install packages.
+- Connect backend by copying `.env.example` to `.env.local`. Make sure the ports are correctly configured in threads_server repo.
+- Run `yarn dev --port 3001` and browse the app at https://localhost:3001.
+
+## Custom Base Path
+
+You can add a `VITE_PATH=/your/base/path` env variable to the env file and this app will use that for routing.
+
+## Tests
+
+### Unit and integration tests
+
+There are no unit or integration tests in this repo.
+
+### Stress testing
+
+Stress tests can be run from the client repo in the [k6 directory](https://github.com/berkmancenter/threads_client/blob/main/k6).