Feature/1 add projects and about pages (#2)

* adding api * adding projects page * adding project page * updating terraform * updating terraform * adding github workflows
2025-02-23 20:45:04 +00:00
parent 2d9cd07358
commit 6deca4c7ea
95 changed files with 14643 additions and 1500 deletions
--- a/api/.eslintrc.js
+++ b/api/.eslintrc.js
@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  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',
+  },
+};
--- a/api/.gitignore
+++ b/api/.gitignore
@@ -0,0 +1,58 @@
+# compiled output
+/dist
+/node_modules
+/build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# temp directory
+.temp
+.tmp
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+local.settings.json
--- a/api/.prettierrc
+++ b/api/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
--- a/api/README.md
+++ b/api/README.md
@@ -0,0 +1,73 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Installation
+
+```bash
+$ npm install
+```
+
+## Running the app
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## Test
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](LICENSE).
--- a/api/nest-cli.json
+++ b/api/nest-cli.json
@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}
--- a/api/package.json
+++ b/api/package.json
@@ -0,0 +1,79 @@
+{
+  "name": "api",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@azure/functions": "^1.0.3",
+    "@nestjs/axios": "^4.0.0",
+    "@nestjs/azure-func-http": "^0.10.0",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^4.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/platform-express": "^10.0.0",
+    "@noahspan/azure-database": "^3.1.2",
+    "@noahspan/noahspan-modules": "^0.6.5",
+    "axios": "^1.7.9",
+    "reflect-metadata": "^0.1.14",
+    "rxjs": "^7.8.1",
+    "uuid": "^11.0.5"
+  },
+  "devDependencies": {
+    "@angular-devkit/schematics": "^19.1.4",
+    "@nestjs/cli": "^10.0.0",
+    "@nestjs/schematics": "^10.0.0",
+    "@nestjs/testing": "^10.0.0",
+    "@schematics/angular": "^19.1.4",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.1",
+    "@types/supertest": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.5.0",
+    "prettier": "^3.0.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}
--- a/api/src/app.controller.spec.ts
+++ b/api/src/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 appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});
--- a/api/src/app.controller.ts
+++ b/api/src/app.controller.ts
@@ -0,0 +1,78 @@
+import {
+  Controller,
+  Get,
+  Headers,
+  Query,
+  StreamableFile,
+  UseGuards
+} from '@nestjs/common';
+// import { Client as MsGraphClient } from '@microsoft/microsoft-graph-client';
+import { MsGraphService } from '@noahspan/noahspan-modules'
+
+@Controller()
+export class AppController {
+  constructor(
+    private readonly msGraphService: MsGraphService
+  ) {}
+
+  @Get('userPhoto')
+  async getProfilePhoto(@Headers() headers: any): Promise<StreamableFile> {
+    // try {
+    //   const graphToken: string = await this.msGraphService.getMsGraphAuth(
+    //     headers.authorization.replace('Bearer ', ''),
+    //     ['user.read']
+    //   );
+    //   const client: MsGraphClient =
+    //     await this.msGraphService.getMsGraphClientDelegated(graphToken);
+    //   const blob: Blob = await client.api(`me/photos('48x48')/$value`).get();
+    //   const arrayBuffer: ArrayBuffer = await blob.arrayBuffer();
+    //   const buffer: Buffer = Buffer.from(arrayBuffer);
+
+    //   return new StreamableFile(buffer, {
+    //     type: 'application/json',
+    //     disposition: `attachment; filename="user_photo.png"`
+    //   });
+    // } catch (error) {
+    //   return error;
+    // }
+
+    try {
+      const buffer = await this.msGraphService.getProfilePhoto(
+        headers.authorization.replace('Bearer ', ''),
+        ['user.read']
+      )
+
+      return new StreamableFile(buffer, {
+        type: 'application/json',
+        disposition: `attachment; filename="user_photo.png"`
+      });
+    } catch (error) {
+      return error;
+    }
+  }
+
+  @Get('userProfile')
+  async getUserProfile(@Headers() headers: any): Promise<any> {
+    // try {
+    //   const graphToken: string = await this.msGraphService.getMsGraphAuth(
+    //     headers.authorization.replace('Bearer ', ''),
+    //     ['user.read']
+    //   );
+    //   const client: MsGraphClient =
+    //     await this.msGraphService.getMsGraphClientDelegated(graphToken);
+    //   const userProfile = await client.api(`me`).get();
+
+    //   return userProfile;
+    // } catch (error) {
+    //   return error;
+    // }
+
+    try {
+      const userProfile = await this.msGraphService.getUserProfile(headers.authorization.replace('Bearer ', ''));
+      
+      return userProfile;
+    } catch (error) {
+      return error;
+    }
+  }
+}
--- a/api/src/app.module.ts
+++ b/api/src/app.module.ts
@@ -0,0 +1,51 @@
+import { Module } from '@nestjs/common';
+import { APP_FILTER, APP_GUARD } from '@nestjs/core';
+import { HttpExceptionFilter } from './filters/http-exception.filter';
+import { ProjectModule } from './project/project.module';
+import { AuthGuard, AuthModule, MsGraphModule } from '@noahspan/noahspan-modules'
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import configuration from './config/configuration';
+import { AppController } from './app.controller';
+
+@Module({
+  imports: [
+    AuthModule.registerAsync({
+      inject: [ConfigService],
+      imports: [ConfigModule],
+      useFactory: async (configService: ConfigService) => {
+        return {
+          clientId: configService.get<string>('clientId'),
+          clientSecret: configService.get<string>('clientSecret'),
+          tenantId: configService.get<string>('tenantId')
+        }
+      }
+    }),
+    ConfigModule.forRoot({
+      load: [configuration]
+    }),
+    MsGraphModule.registerAsync({
+      inject: [ConfigService],
+      imports: [ConfigModule],
+      useFactory: async (configService: ConfigService) => {
+        return {
+          clientId: configService.get<string>('clientId'),
+          clientSecret: configService.get<string>('clientSecret'),
+          tenantId: configService.get<string>('tenantId')
+        }
+      }
+    }),
+    ProjectModule
+  ],
+  controllers: [AppController],
+  providers: [
+    {
+      provide: APP_FILTER,
+      useClass: HttpExceptionFilter
+    },
+    {
+      provide: APP_GUARD,
+      useClass: AuthGuard
+    }
+  ]
+})
+export class AppModule {}
--- a/api/src/config/configuration.ts
+++ b/api/src/config/configuration.ts
@@ -0,0 +1,5 @@
+export default () => ({
+  clientId: process.env.CLIENT_ID,
+  clientSecret: process.env.CLIENT_SECRET,
+  tenantId: process.env.TENANT_ID
+})
--- a/api/src/filters/http-exception.filter.ts
+++ b/api/src/filters/http-exception.filter.ts
@@ -0,0 +1,25 @@
+import {
+  ExceptionFilter,
+  Catch,
+  ArgumentsHost,
+  HttpException
+} from '@nestjs/common';
+import { Request, Response } from 'express';
+
+@Catch(HttpException)
+export class HttpExceptionFilter implements ExceptionFilter {
+  catch(excpetion: HttpException, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse<Response>();
+    const request = ctx.getRequest<Request>();
+    const status = excpetion.getStatus();
+
+    response.status(status).json({
+      name: excpetion.cause,
+      message: excpetion.message,
+      statusCode: status,
+      timestamp: new Date().toISOString(),
+      path: request.url
+    });
+  }
+}
--- a/api/src/main.ts
+++ b/api/src/main.ts
@@ -0,0 +1,27 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+import { HttpService } from '@nestjs/axios';
+import { HttpExceptionFilter } from './filters/http-exception.filter';
+import { InternalServerErrorException } from '@nestjs/common';
+
+async function bootstrap() {
+  const httpService = new HttpService();
+  const app = await NestFactory.create(AppModule);
+
+  app.enableCors();
+  app.setGlobalPrefix('api');
+  app.useGlobalFilters(new HttpExceptionFilter());
+  httpService.axiosRef.interceptors.response.use(
+    (response) => {
+      return response;
+    },
+    (error) => {
+      console.error('Internal server error exception', error);
+
+      throw new InternalServerErrorException();
+    }
+  );
+  
+  await app.listen(3000);
+}
+bootstrap();
--- a/api/src/project/project.controller.ts
+++ b/api/src/project/project.controller.ts
@@ -0,0 +1,94 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  HttpException,
+  Param,
+  Post,
+  Put,
+  UseGuards
+} from '@nestjs/common';
+import { ProjectDto } from './project.dto';
+import { Project } from './project.entity';
+import { ProjectService } from './project.service';
+import { CustomError, Public } from '@noahspan/noahspan-modules';
+
+@Controller('projects')
+export class ProjectController {
+  constructor(private readonly projectService: ProjectService) {}
+
+  @Get(':partitionKey/:rowKey')
+  async find(
+    @Param('partitionKey') partitionKey: string,
+    @Param('rowKey') rowKey: string
+  ) {
+    try {
+      return await this.projectService.find(partitionKey, rowKey);
+    } catch (error) {
+      const customError = error as CustomError;
+
+      throw new HttpException(customError.message, customError.statusCode);
+    }
+  }
+
+  @Public()
+  @Get()
+  async findAll() {
+    try {
+      return await this.projectService.findAll();
+    } catch (error) {
+      const customError = error as CustomError;
+
+      throw new HttpException(customError.message, customError.statusCode);
+    }
+  }
+
+  @Post()
+  async create(@Body() projectDto: ProjectDto) {
+    try {
+      const project = new Project();
+
+      Object.assign(project, projectDto);
+
+      return await this.projectService.create(project);
+    } catch (error) {
+      const customError = error as CustomError;
+
+      throw new HttpException(customError.message, customError.statusCode);
+    }
+  }
+
+  @Put(':partitionKey/:rowKey')
+  async update(
+    @Param('partitionKey') partitionKey: string,
+    @Param('rowKey') rowKey: string,
+    @Body() projectDto: ProjectDto
+  ) {
+    try {
+      const project = new Project();
+
+      Object.assign(project, projectDto);
+
+      return await this.projectService.update(partitionKey, rowKey, project);
+    } catch (error) {
+      const customError = error as CustomError;
+
+      throw new HttpException(customError.message, customError.statusCode);
+    }
+  }
+
+  @Delete(':partitionKey/:rowKey')
+  async delete(
+    @Param('partitionKey') partitionKey: string,
+    @Param('rowKey') rowKey: string
+  ) {
+    try {
+      return await this.projectService.delete(partitionKey, rowKey);
+    } catch (error) {
+      const customError = error as CustomError;
+
+      throw new HttpException(customError.message, customError.statusCode);
+    }
+  }
+}
--- a/api/src/project/project.dto.ts
+++ b/api/src/project/project.dto.ts
@@ -0,0 +1,6 @@
+export class ProjectDto {
+  rowKey: string;
+  displayName: string;
+  icon: string;
+  summary: string;
+}
--- a/api/src/project/project.entity.ts
+++ b/api/src/project/project.entity.ts
@@ -0,0 +1,7 @@
+export class Project {
+  partitionKey: string;
+  rowKey: string;
+  displayName: string;
+  icon: string;
+  summary: string;
+}
--- a/api/src/project/project.module.ts
+++ b/api/src/project/project.module.ts
@@ -0,0 +1,27 @@
+import { Module } from '@nestjs/common';
+import { ProjectController } from './project.controller';
+import { ProjectService } from './project.service';
+import { AzureTableStorageModule } from '@noahspan/azure-database';
+import { Project } from './project.entity';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+
+@Module({
+  imports: [
+    AzureTableStorageModule.forRootAsync({
+      imports: [ConfigModule],
+      useFactory: async (configService: ConfigService) => {
+        return {
+          connectionString: configService.get<string>('azureStorageConnectionString')
+        };
+      },
+      inject: [ConfigService]
+    }),
+    AzureTableStorageModule.forFeature(Project, {
+      createTableIfNotExists: true,
+      table: 'projects'
+    }),
+  ],
+  controllers: [ProjectController],
+  providers: [ProjectService]
+})
+export class ProjectModule {}
--- a/api/src/project/project.service.ts
+++ b/api/src/project/project.service.ts
@@ -0,0 +1,38 @@
+import { InjectRepository, Repository } from '@noahspan/azure-database';
+import { Injectable } from '@nestjs/common';
+import { Project } from './project.entity';
+import { v4 as uuidv4 } from 'uuid';
+
+@Injectable()
+export class ProjectService {
+  constructor(
+    @InjectRepository(Project)
+    private readonly projectRepository: Repository<Project>
+  ) {}
+
+  async find(partitionKey: string, rowKey: string): Promise<Project> {
+    return await this.projectRepository.find(partitionKey, rowKey);
+  }
+
+  async findAll(): Promise<Project[]> {
+    return await this.projectRepository.findAll();
+  }
+
+  async create(project: Project): Promise<Project> {
+    project.partitionKey = 'project';
+
+    return await this.projectRepository.create(project);
+  }
+
+  async update(
+    partitionKey: string,
+    rowKey: string,
+    project: Project
+  ): Promise<Project> {
+    return await this.projectRepository.update(partitionKey, rowKey, project);
+  }
+
+  async delete(partitionKey: string, rowKey: string): Promise<void> {
+    await this.projectRepository.delete(partitionKey, rowKey);
+  }
+}
--- a/api/test/app.e2e-spec.ts
+++ b/api/test/app.e2e-spec.ts
@@ -0,0 +1,24 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { AppModule } from './../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});
--- a/api/test/jest-e2e.json
+++ b/api/test/jest-e2e.json
@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}
--- a/api/tsconfig.build.json
+++ b/api/tsconfig.build.json
@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}
--- a/api/tsconfig.json
+++ b/api/tsconfig.json
@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false
+  }
+}