initial

Author: reneSpeaks

.env.EXAMPLE

@@ -0,0 +1,16 @@
+## Database configuration
+DB_DIALECT=postgres
+DB_HOST=
+DB_PORT=
+DB_NAME=
+DB_USER=
+DB_PASSWORD=
+
+## Server configuration
+NODE_ENV=development
+NODE_HOST=http://localhost
+NODE_PORT=3001
+
+## JSON Web Token configuration
+JWT_SECRET=
+JWT_EXPIRES_IN=28800 # 8 hours

.github/workflows/quality-checks.yml

@@ -0,0 +1,46 @@
+name: Quality Checks
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+        paths-ignore:
+            - .github/workflows/quality-checks.yml # Ignore changes to this file
+    # Allows you to run this workflow manually from the Actions tap on GitHub.
+    workflow_dispatch:
+
+jobs:
+    quality-checks:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: .nvmrc
+                  cache: 'npm'
+
+            - name: Install dependencies
+              run: npm ci
+
+            - name: Run tests
+              run: npm run test:run
+
+            - name: Run TypeScript type checking
+              run: npm run type-check
+
+            - name: Run ESLint and fix
+              run: npm run lint:fix
+
+            - name: Format with Prettier
+              run: npm run format
+
+            - name: Check for remaining ESLint errors
+              run: npm run lint
+
+            - name: Check for remaining formatting issues
+              run: npm run format:check

.gitignore

@@ -0,0 +1,28 @@
+# Node.js dependencies
+node_modules/
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+
+# Environment variables
+.env
+.env.*
+!.env.EXAMPLE
+
+# Seed
+seed.ts
+
+# Build output
+dist/
+
+# TypeScript
+*.tsbuildinfo
+
+# OS generated files
+.DS_Store
+Thumbs.db
+
+# Test coverage
+coverage/

.husky/pre-commit

@@ -0,0 +1,32 @@
+echo '🕦 Running Tests before committing'
+echo 'this may take a while, please be patient.'
+
+# Check if the tests are passing
+npm run test:run || {
+    echo '❌ You have issue in your code, please check tests.'
+    echo 'Run npm run test, make changes and try committing again.';
+    false;
+}
+
+echo '🕦 Checking types before committing'
+echo 'this may take a while, please be patient.'
+
+# Check types
+npm run type-check || {
+    echo '❌ You have issue in your code, please check types.'
+    echo 'Run npm run type-check, make changes and try committing again.';
+    false;
+}
+
+echo '🕦 Linting your changes before committing'
+echo 'this may take a while, please be patient.'
+
+# Check ESLint Standards
+npx lint-staged ||
+(
+    echo '❌ You have issue in your code, please check linter.'
+    echo 'Run npm run lint, make changes and try committing again.';
+    false;
+)
+
+echo '✅ No errors found: committing this now.... 🚀'

.nvmrc

@@ -0,0 +1 @@
+v22.14.0

.prettierignore

@@ -0,0 +1,12 @@
+package*.json
+build
+dist
+coverage
+resources
+
+**/node_modules/*
+**/.vscode/*
+**/.idea/*
+**/.astro/*
+
+*.md

.prettierrc

@@ -0,0 +1,10 @@
+{
+    "endOfLine": "auto",
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "tabWidth": 4,
+    "printWidth": 140,
+    "bracketSpacing": true,
+    "bracketSameLine": true
+}

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "ms-vscode.vscode-typescript-next"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true
+}

CODEOWNERS

@@ -0,0 +1,3 @@
+# Default owners for everything in the repo
+
+*       @reneSpeaks