Dev to Main

.env

@@ -5,4 +5,7 @@ NODE_ENV=local
 APP_ENV=Local
 CORS_DOMAIN='http://localhost:5173,http://127.0.0.1:5173,http://127.0.0.1:3000'
 ANON_DB_PATH=/Users/braydonharris/dev/personal-projects/tak/server/games_anon.db
-DIST_PATH=dist/
+DIST_PATH=dist/
+PREVIOUS_FILE=previous.txt
+RATING_OUTPUT_PATH=dist/
+RATING_CRON_VALUE='0 15 * * * *'

.eslintrc.js

@@ -21,6 +21,10 @@ module.exports = {
 		'@typescript-eslint/explicit-function-return-type': 'off',
 		'@typescript-eslint/explicit-module-boundary-types': 'off',
 		'@typescript-eslint/no-explicit-any': 'off',
-		indent: ['warn', 'tab', { SwitchCase: 1 }],
+		indent: ['warn', 'tab', { SwitchCase: 1, "ignoredNodes": [
+                `FunctionExpression > .params[decorators.length > 0]`,
+                `FunctionExpression > .params > :matches(Decorator, :not(:first-child))`,
+                `ClassBody.body > PropertyDefinition[decorators.length > 0] > .key`,
+            ], }],
 	},
 };

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches: 
       - main
+      - dev
 
 jobs:
   lint_and_test:

.github/workflows/deploy-dev.yaml

@@ -44,6 +44,9 @@ jobs:
             ANON_DB_PATH: ${{ secrets.ANON_DB_PATH }}
             DB_PATH: ${{ secrets.DB_PATH }}
             APP_ENV: ${{ secrets.APP_ENV }} 
+            PREVIOUS_FILE: ${{ secrets.PREVIOUS_FILE }}
+            RATING_OUTPUT_PATH: ${{ secrets.RATING_OUTPUT_PATH }}
+            RATING_CRON_VALUE: ${{ secrets.RATING_CRON_VALUE }}
         run : |
             rm .env
             touch .env
@@ -53,8 +56,12 @@ jobs:
             echo "ANON_DB_PATH = ${ANON_DB_PATH}" >> .env
             echo "DB_PATH = ${DB_PATH}" >> .env
             echo "APP_ENV = ${APP_ENV}" >> .env
+            echo "PREVIOUS_FILE = ${PREVIOUS_FILE}" >> .env
+            echo "RATING_OUTPUT_PATH = ${RATING_OUTPUT_PATH}" >> .env
+            echo "RATING_CRON_VALUE = ${RATING_CRON_VALUE}" >> .env
             mv .env ./dist
             mv node_modules ./dist
+            mv previous.txt ./dist
             tar -czf artifact.tar.gz ./dist 
       - name: Deploy
         env: 
@@ -70,9 +77,11 @@ jobs:
             rm -rf playtak-api-dev-tmp
             mkdir playtak-api-dev-tmp
             tar -xzf artifact.tar.gz -C ./playtak-api-dev-tmp
+            cp /var/apps/playtak-api-beta/previous.txt playtak-api-dev-tmp/previous.txt
             sudo rm -rf /var/apps/playtak-api-beta
             sudo mv playtak-api-dev-tmp/dist/ /var/apps/playtak-api-beta
-            rm -rf playtak-api-dev-temp
+            cp playtak-api-dev-tmp/previous.txt /var/apps/playtak-api-beta/previous.txt
+            rm -rf playtak-api-dev-tmp
             rm artifact.tar.gz
             pm2 restart playtak-api-beta --update-env
           '

.github/workflows/deploy-prod.yaml

@@ -44,6 +44,9 @@ jobs:
             ANON_DB_PATH: ${{ secrets.ANON_DB_PATH }}
             DB_PATH: ${{ secrets.DB_PATH }}
             APP_ENV: ${{ secrets.APP_ENV }}
+            PREVIOUS_FILE: ${{ secrets.PREVIOUS_FILE }}
+            RATING_OUTPUT_PATH: ${{ secrets.RATING_OUTPUT_PATH }}
+            RATING_CRON_VALUE: ${{ secrets.RATING_CRON_VALUE }}
         run : |
             rm .env
             touch .env
@@ -53,6 +56,9 @@ jobs:
             echo "ANON_DB_PATH = ${ANON_DB_PATH}" >> .env
             echo "DB_PATH = ${DB_PATH}" >> .env
             echo "APP_ENV = ${APP_ENV}" >> .env
+            echo "PREVIOUS_FILE = ${PREVIOUS_FILE}" >> .env
+            echo "RATING_OUTPUT_PATH = ${RATING_OUTPUT_PATH}" >> .env
+            echo "RATING_CRON_VALUE = ${RATING_CRON_VALUE}" >> .env
             mv .env ./dist
             mv node_modules ./dist
             tar -czf artifact.tar.gz ./dist 
@@ -70,9 +76,11 @@ jobs:
             rm -rf playtak-api-tmp
             mkdir playtak-api-tmp
             tar -xzf artifact.tar.gz -C ./playtak-api-tmp
+            cp /var/apps/playtak-api-prod/previous.txt playtak-api-tmp/previous.txt
             sudo rm -rf /var/apps/playtak-api-prod
             sudo mv playtak-api-tmp/dist/ /var/apps/playtak-api-prod
-            rm -rf playtak-api-temp
+            cp playtak-api-tmp/previous.txt /var/apps/playtak-api-prod/previous.txt
+            rm -rf playtak-api-tmp
             rm artifact.tar.gz
             pm2 restart playtak-api-prod --update-env
           '

.gitignore

@@ -35,4 +35,6 @@ lerna-debug.log*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
-!.vscode/extensions.json
+!.vscode/extensions.json
+
+previous.txt

README.md

@@ -1,12 +1,15 @@
-# Playtak-api 
+# PlayTak-API 
 
 ## Description
 
-![Unit Tests](https://github.com/USTakAssociation/playtak-api/actions/workflows/ci.yml/badge.svg
-)
+![Unit Tests](https://github.com/USTakAssociation/playtak-api/actions/workflows/ci.yml/badge.svg)
 
 
-This is the Play Tak API projects which contains multiple endpoints for serivcing data to the Play Tak UI
+This is the Play Tak API project which contains multiple endpoints for servicing data to the Play Tak UI
+
+## Requirements
+- node v16.17.1
+- sqlite3
 
 ## Installation
 
@@ -16,6 +19,8 @@ $ npm install
 
 ## Running the app
 
+
+*Note: be sure to update the .env file with the correct paths to where the sqlite db files are located*
 ```bash
 # development
 $ npm run start
@@ -47,21 +52,31 @@ https://api.playtak.com/api
 
 https://api.{env}.playtak.com
 
+Events
 - /events
+
+Games History
 - /v1/games-history/
 - /v1/games-history/{id}
-- /v1/games-historoy/ptn/{id}
+- /v1/games-history/ptn/{id}
 - /v1/hames-history/db
 
-## TODO
+Ratings
+- /v1/ratings
+- /v1/ratings/{player_name}
 
-- Finish up migrating rerating to nest
-- endpoints for getting rating data
+## TODO
 - create user auth endpoints and test
+- dockerize app
+- automatically setup db files in the project and fill with dummy data
+- setup API key registration to track usage
+- add automated versioning and setup release artifacts with github
+- build out more robust deploy and rollback
+- add health check endpoint
 
 
 ## Contributing
-PlayTak is an OPEN Open Source Project. This means that:
+PlayTak is an Open Source Project. This means that:
 
 > Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit.
 
@@ -78,7 +93,7 @@ Please read [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on our code of c
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this repository.
 
 ## Contributors
-Play tak is only possible due to the excellent work of the following contributors:
+PlayTak is only possible due to the excellent work of the following contributors:
 
 ||
 :----:|

nest-cli.json

@@ -3,6 +3,7 @@
 	"collection": "@nestjs/schematics",
 	"sourceRoot": "src",
 	"compilerOptions": {
-		"assets": ["assets/**/*"]
+		"assets": ["assets/**/*"],
+		"plugins": ["@nestjs/swagger"]
 	}
 }