Merge pull request #21 from amosproj/setup-nest

Initialized Project and Setup Files

Author: heskil

.gitignore

@@ -34,3 +34,11 @@ bin/
 
 # MacOS
 .DS_Store
+
+# Local env files
+apps/*/.env
+
+.nx/cache
+.nx/workspace-data
+**/vite.config.{js,ts,mjs,mts,cjs,cts}.timestamp*
+.angular

.npmrc

@@ -0,0 +1 @@
+package-lock=true

.prettierignore

@@ -0,0 +1,6 @@
+# Add files here to ignore them from prettier formatting
+/dist
+/coverage
+/.nx/cache
+/.nx/workspace-data
+.angular

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

Documentation/README.md

@@ -1,2 +1,21 @@
 Build, user, and technical documentation
 Software architecture description
+
+basic setup:
+
+- `npm ci`: dependency install
+- copy `.env.example` file and rename to `.env` (adjust database properties according to database setup if necessary)
+
+running the code locally:
+
+- `npm run be`: run backend individually
+- `npm run fe`: run frontend individually
+- `npm run both`: run backend and frontend
+
+generating database migrations:
+
+- the entity files need to be annotated with `@Entity(<table-name>)`
+- append the entity file to the `entities` array in `db-config.service.ts`
+- run the following command to generate a migration file:
+    - `nx run metadata-analyzer-backend:migrations:generate --name <migration-name>`
+- append the generated file to the `migrations` array in `db-config.service.ts`

apps/backend-e2e/eslint.config.cjs

@@ -0,0 +1,3 @@
+const baseConfig = require('../../eslint.config.cjs');
+
+module.exports = [...baseConfig];

apps/backend-e2e/jest.config.ts

@@ -0,0 +1,18 @@
+export default {
+	displayName: "metadata-analyzer-backend-e2e",
+	preset: "../../jest.preset.cjs",
+	globalSetup: "<rootDir>/src/support/global-setup.ts",
+	globalTeardown: "<rootDir>/src/support/global-teardown.ts",
+	setupFiles: ["<rootDir>/src/support/test-setup.ts"],
+	testEnvironment: "node",
+	transform: {
+		"^.+\\.[tj]s$": [
+			"ts-jest",
+			{
+				tsconfig: "<rootDir>/tsconfig.spec.json",
+			},
+		],
+	},
+	moduleFileExtensions: ["ts", "js", "html"],
+	coverageDirectory: "../../coverage/metadata-analyzer-backend-e2e",
+};

apps/backend-e2e/project.json

@@ -0,0 +1,17 @@
+{
+  "name": "metadata-analyzer-backend-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "implicitDependencies": ["metadata-analyzer-backend"],
+  "targets": {
+    "e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{e2eProjectRoot}"],
+      "options": {
+        "jestConfig": "apps/backend-e2e/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "dependsOn": ["metadata-analyzer-backend:build"]
+    }
+  }
+}

apps/backend-e2e/src/metadata-analyzer-backend/metadata-analyzer-backend.spec.ts

@@ -0,0 +1,10 @@
+import axios from 'axios';
+
+describe('GET /api', () => {
+  it('should return a message', async () => {
+    const res = await axios.get(`/api`);
+
+    expect(res.status).toBe(200);
+    expect(res.data).toEqual({ message: 'Hello API' });
+  });
+});

apps/backend-e2e/src/support/global-setup.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+var __TEARDOWN_MESSAGE__: string;
+
+module.exports = async function () {
+  // Start services that that the app needs to run (e.g. database, docker-compose, etc.).
+  console.log('\nSetting up...\n');
+
+  // Hint: Use `globalThis` to pass variables to global teardown.
+  globalThis.__TEARDOWN_MESSAGE__ = '\nTearing down...\n';
+};

apps/backend-e2e/src/support/global-teardown.ts

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+module.exports = async function () {
+  // Put clean up logic here (e.g. stopping services, docker-compose, etc.).
+  // Hint: `globalThis` is shared between setup and teardown.
+  console.log(globalThis.__TEARDOWN_MESSAGE__);
+};

apps/backend-e2e/src/support/test-setup.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+
+import axios from 'axios';
+
+module.exports = async function () {
+  // Configure axios for tests to use.
+  const host = process.env.HOST ?? 'localhost';
+  const port = process.env.PORT ?? '3000';
+  axios.defaults.baseURL = `http://${host}:${port}`;
+};

apps/backend-e2e/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

apps/backend-e2e/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "ESNext",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.ts"]
+}

apps/backend/.env.example

@@ -0,0 +1,5 @@
+DATABASE_HOST="localhost"
+DATABASE_PORT=5433
+DATABASE_USER="postgres"
+DATABASE_PASSWORD="postgres"
+DATABASE_DATABASE="postgres"

apps/backend/esbuild.config.cjs

@@ -0,0 +1,12 @@
+const esbuildPluginTsc = require('esbuild-plugin-tsc');
+const path = require('node:path');
+
+/** @type {import('esbuild').BuildOptions}  */
+module.exports = {
+  keepNames: true,
+  plugins: [
+    esbuildPluginTsc({
+      tsconfigPath: path.join(__dirname, 'tsconfig.app.json'),
+    }),
+  ],
+};

apps/backend/eslint.config.cjs

@@ -0,0 +1,3 @@
+const baseConfig = require('../../eslint.config.cjs');
+
+module.exports = [...baseConfig];

apps/backend/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'metadata-analyzer-backend',
+  preset: '../../jest.preset.cjs',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/apps/backend',
+};

apps/backend/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "metadata-analyzer-backend",
+  "type": "module",
+  "version": "0.0.1"
+}

apps/backend/project.json

@@ -0,0 +1,86 @@
+{
+  "name": "metadata-analyzer-backend",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/backend/src",
+  "projectType": "application",
+  "tags": [],
+  "targets": {
+    "serve": {
+      "executor": "@nx/js:node",
+      "defaultConfiguration": "development",
+      "options": {
+        "buildTarget": "metadata-analyzer-backend:build"
+      },
+      "configurations": {
+        "development": {
+          "buildTarget": "metadata-analyzer-backend:build:development"
+        },
+        "production": {
+          "buildTarget": "metadata-analyzer-backend:build:production"
+        }
+      }
+    },
+    "preview": {
+      "dependsOn": [
+        "build"
+      ],
+      "executor": "@nx/vite:preview-server",
+      "defaultConfiguration": "development",
+      "options": {
+        "buildTarget": "metadata-analyzer-backend:build"
+      },
+      "configurations": {
+        "development": {
+          "buildTarget": "metadata-analyzer-backend:build:development",
+          "hmr": true
+        },
+        "production": {
+          "buildTarget": "metadata-analyzer-backend:build:production",
+          "hmr": true
+        }
+      }
+    },
+    "build": {
+      "executor": "@nx/esbuild:esbuild",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "defaultConfiguration": "production",
+      "options": {
+        "main": "apps/backend/src/main.ts",
+        "outputPath": "dist/apps/backend",
+        "tsConfig": "apps/backend/tsconfig.app.json",
+        "assets": [],
+        "platform": "node",
+        "additionalEntryPoints": [
+          "{projectRoot}/src/migrations.main.ts"
+        ]
+      },
+      "configurations": {
+        "development": {
+          "minify": false
+        },
+        "production": {
+          "minify": true
+        }
+      }
+    },
+    "migrations": {
+      "executor": "nx:run-commands",
+      "dependsOn": [
+        "build"
+      ],
+      "configurations": {
+        "run": {
+          "command": "npx typeorm-ts-node-esm -d dist/apps/backend/migrations.main.js migration:run"
+        },
+        "generate": {
+          "command": "npx typeorm-ts-node-esm -d dist/apps/backend/migrations.main.js migration:generate apps/backend/src/app/migrations/{args.name}"
+        },
+        "revert": {
+          "command": "npx typeorm-ts-node-esm -d dist/apps/backend/migrations.main.js migration:revert"
+        }
+      }
+    }
+  }
+}

apps/backend/src/app/app.controller.spec.ts

@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let app: TestingModule;
+
+  beforeAll(async () => {
+    app = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+  });
+
+  describe('getData', () => {
+    it('should return "Hello API"', () => {
+      const appController = app.get<AppController>(AppController);
+      expect(appController.getData()).toEqual({ message: 'Hello API' });
+    });
+  });
+});

apps/backend/src/app/app.controller.ts

@@ -0,0 +1,19 @@
+import {Controller, Get} from '@nestjs/common';
+
+import {AppService} from './app.service';
+import {ApiOperation} from '@nestjs/swagger';
+
+@Controller()
+export class AppController {
+    constructor(
+        private readonly appService: AppService) {
+    }
+
+    @ApiOperation({
+        summary: 'Dummy Endpoint for testing basic setup',
+    })
+    @Get('data')
+    getData() {
+        return this.appService.getData();
+    }
+}

apps/backend/src/app/app.module.ts

@@ -0,0 +1,25 @@
+import {Module} from '@nestjs/common';
+import {ConfigModule} from '@nestjs/config';
+
+import {AppController} from './app.controller';
+import {AppService} from './app.service';
+import {TypeOrmModule} from '@nestjs/typeorm';
+import {DbConfigService} from "./db-config.service";
+import {DemoModule} from "./demo/demo.module";
+
+@Module({
+    imports: [
+        ConfigModule.forRoot({
+            isGlobal: true,
+        }),
+        TypeOrmModule.forRootAsync({
+            imports: [ConfigModule],
+            useClass: DbConfigService,
+        }),
+        DemoModule
+    ],
+    controllers: [AppController],
+    providers: [AppService],
+})
+export class AppModule {
+}

apps/backend/src/app/app.service.spec.ts

@@ -0,0 +1,21 @@
+import { Test } from '@nestjs/testing';
+
+import { AppService } from './app.service';
+
+describe('AppService', () => {
+  let service: AppService;
+
+  beforeAll(async () => {
+    const app = await Test.createTestingModule({
+      providers: [AppService],
+    }).compile();
+
+    service = app.get<AppService>(AppService);
+  });
+
+  describe('getData', () => {
+    it('should return "Hello API"', () => {
+      expect(service.getData()).toEqual({ message: 'Hello API' });
+    });
+  });
+});

apps/backend/src/app/app.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getData(): { message: string } {
+    return { message: 'Hello API' };
+  }
+}