Merge pull request #27 from USTakAssociation/dev

Dev to Main
PR's already reviewed into dev

Author: invaderb

.github/workflows/api-cd-dev.yaml

@@ -9,7 +9,7 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     environment: Beta
 
@@ -61,7 +61,6 @@ jobs:
             RATING_OUTPUT_PATH: ${{ secrets.RATING_OUTPUT_PATH }}
             RATING_CRON_VALUE: ${{ secrets.RATING_CRON_VALUE }}
         run : |
-            rm .env
             touch .env
             echo "PORT = ${PORT}" >> .env
             echo "NODE_ENV = ${NODE_ENV}" >> .env

.github/workflows/api-cd-prod.yaml

@@ -9,7 +9,7 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     environment: Prod
 
@@ -52,7 +52,6 @@ jobs:
             RATING_OUTPUT_PATH: ${{ secrets.RATING_OUTPUT_PATH }}
             RATING_CRON_VALUE: ${{ secrets.RATING_CRON_VALUE }}
         run : |
-            rm .env
             touch .env
             echo "PORT = ${PORT}" >> .env
             echo "NODE_ENV = ${NODE_ENV}" >> .env

api/.env api/.env.exampleapi/.env renamed to api/.env.example

@@ -1,10 +1,9 @@
 PORT=3004
-DB_NAME=irms
-DB_PATH=/playtakdb
+DB_PATH=../playtakdb
 NODE_ENV=local
 APP_ENV=Local
 CORS_DOMAIN='*'
-ANON_DB_PATH=/playtakdb/games_anon.db
+ANON_DB_PATH=../playtakdb/games_anon.db
 DIST_PATH=dist/
 PREVIOUS_FILE=previous.txt
 RATING_OUTPUT_PATH=dist/

api/.eslintrc

@@ -36,4 +36,5 @@ lerna-debug.log*
 !.vscode/launch.json
 !.vscode/extensions.json
 
-previous.txt
+previous.txt
+.env

api/.eslintrc.js

@@ -1,6 +1,7 @@
 {
 	"singleQuote": true,
-	"trailingComma": "all",
+	"trailingComma": "none",
 	"useTabs": true,
-	"tabWidth": 4
+	"tabWidth": 4,
+	"printWidth": 120
 }

api/.gitignore

@@ -1,4 +1,4 @@
-FROM node:20-alpine3.21 AS development
+FROM node:22-alpine3.21 AS development
 WORKDIR /usr/src/app
 
 # Copy package files

api/.prettierrc

@@ -17,6 +17,11 @@ npm install
 
 ## Running the app
 
+First, need to set up the .env file which you can copy from the .env.example file.
+```
+cp .env.example .env
+```
+
 There are two options to run the project: manually, or with docker (recommended).
 
 Either way, you will need to create two databases, which can be done with the following bash script:
@@ -73,21 +78,24 @@ $ npm run test:cov
 SwaggerOpenAPI Documentation
 
 https://api.playtak.com/api
-
 https://api.beta.playtak.com/api
 
 Events
 
-- /events
+- GET /events
 
 Games History
 
-- /v1/games-history/
-- /v1/games-history/{id}
-- /v1/games-history/ptn/{id}
-- /v1/hames-history/db
+- GET /v1/games-history/
+- GET /v1/games-history/{id}
+- GET /v1/games-history/ptn/{id}
+- GET /v1/hames-history/db
 
 Ratings
 
-- /v1/ratings
-- /v1/ratings/{player_name}
+- GET /v1/ratings
+- GET /v1/ratings/{player_name}
+
+Misc
+
+- GET /health

api/Dockerfile

@@ -1,79 +1,67 @@
-import typescriptEslintEslintPlugin from "@typescript-eslint/eslint-plugin";
-import globals from "globals";
-import tsParser from "@typescript-eslint/parser";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
+import typescriptEslintPlugin from '@typescript-eslint/eslint-plugin';
+import globals from 'globals';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const compat = new FlatCompat({
 	baseDirectory: __dirname,
 	recommendedConfig: js.configs.recommended,
-	allConfig: js.configs.all
+	allConfig: js.configs.all,
 });
 
-export default [{
-	ignores: ["**/.eslintrc.js"],
-}, ...compat.extends("plugin:@typescript-eslint/recommended"), {
-	plugins: {
-		"@typescript-eslint": typescriptEslintEslintPlugin,
+export default [
+	{
+		ignores: ['**/eslint.config.mjs'],
 	},
-
-	languageOptions: {
-		globals: {
-			...globals.node,
-			...globals.jest,
+	...compat.extends(
+		'plugin:@typescript-eslint/recommended',
+		'plugin:prettier/recommended',
+	),
+	{
+		plugins: {
+			'@typescript-eslint': typescriptEslintPlugin,
 		},
 
-		parser: tsParser,
-		ecmaVersion: 5,
-		sourceType: "module",
+		languageOptions: {
+			globals: {
+				...globals.node,
+				...globals.jest,
+			},
 
-		parserOptions: {
-			project: "tsconfig.json",
-			tsconfigRootDir: "./",
-		},
-	},
+			parser: tsParser,
+			ecmaVersion: 5,
+			sourceType: 'module',
 
-	rules: {
-		"@typescript-eslint/interface-name-prefix": "off",
-		"@typescript-eslint/explicit-function-return-type": "off",
-		"@typescript-eslint/explicit-module-boundary-types": "off",
-		"@typescript-eslint/no-explicit-any": "off",
-		"@typescript-eslint/no-unused-expressions": "off",
-		"eol-last": "off",
-		"brace-style": "off",
-		"comma-dangle": "off",
-		"comma-spacing": "off",
-		eqeqeq: "off",
-		indent: "off",
-		"key-spacing": "off",
-		"keyword-spacing": "off",
-		"max-len": "off",
-		"no-ex-assign": "off",
-		"no-extra-boolean-cast": "off",
-		"no-floating-decimal": "off",
-		"no-multi-spaces": "off",
-		"no-throw-literal": "off",
-		"no-unreachable": "off",
-		radix: "off",
-		"quote-props": "off",
-		quotes: "off",
-		"space-before-function-paren": "off",
-		"space-in-parens": "off",
-		"space-infix-ops": "off",
-		"space-unary-ops": "off",
-		"spaced-comment": "off",
-		indent: ["warn", "tab", {
-			SwitchCase: 1,
+			parserOptions: {
+				project: path.resolve(__dirname, 'tsconfig.json'),
+			},
+		},
 
-			ignoredNodes: [
-				"FunctionExpression > .params[decorators.length > 0]",
+		rules: {
+			'@typescript-eslint/interface-name-prefix': 'off',
+			'@typescript-eslint/explicit-function-return-type': 'off',
+			'@typescript-eslint/explicit-module-boundary-types': 'off',
+			'@typescript-eslint/no-explicit-any': 'off',
+			indent: [
+				'error',
+				'tab',
+				{
+					SwitchCase: 1,
+					flatTernaryExpressions: false,
+					ignoredNodes: [
+						'FunctionExpression[params]:has(Identifier[decorators])',
+										"FunctionExpression > .params[decorators.length > 0]",
 				"FunctionExpression > .params > :matches(Decorator, :not(:first-child))",
 				"ClassBody.body > PropertyDefinition[decorators.length > 0] > .key",
+					],
+				},
 			],
-		}],
+			'comma-dangle': 'off',
+		},
 	},
-}];
+];