Repository: amitavdevzone/nest-js-quiz-manager Branch: master Commit: 3ff3564299b5 Files: 76 Total size: 52.2 KB Directory structure: gitextract_f_h8i67j/ ├── LICENSE ├── readme.md └── server/ ├── .editorconfig ├── .eslintrc.js ├── .gitignore ├── .prettierrc ├── README.md ├── nest-cli.json ├── package.json ├── src/ │ ├── app.controller.spec.ts │ ├── app.controller.ts │ ├── app.module.ts │ ├── app.service.ts │ ├── app.utils.ts │ ├── common/ │ │ ├── constants/ │ │ │ └── event.constants.ts │ │ ├── decorator/ │ │ │ └── api-pagination.response.ts │ │ ├── dto/ │ │ │ └── paginated.dto.ts │ │ ├── exceptions/ │ │ │ └── api-token-payement.exception.ts │ │ └── middleware/ │ │ └── api-token-check.middleware.ts │ ├── config/ │ │ ├── app.config.ts │ │ ├── jwt.config.ts │ │ ├── typeorm.config-migrations.ts │ │ └── typeorm.config.ts │ ├── database/ │ │ ├── data/ │ │ │ └── quiz.data.ts │ │ ├── factories/ │ │ │ ├── quiz.factory.ts │ │ │ └── user.factory.ts │ │ ├── migrations/ │ │ │ ├── 1649938237326-BaseMigrations.ts │ │ │ └── 1651075479367-add_user_role_column.ts │ │ └── seeds/ │ │ ├── setup-data.seed.ts │ │ └── user-create.seed.ts │ ├── main.ts │ └── modules/ │ ├── auth/ │ │ ├── admin-role.guard.ts │ │ ├── auth.controller.ts │ │ ├── auth.module.ts │ │ ├── auth.service.ts │ │ ├── dto/ │ │ │ └── login.dto.ts │ │ ├── jwt-auth.guard.ts │ │ ├── jwt.strategy.ts │ │ ├── local-auth.guard.ts │ │ ├── local.strategy.ts │ │ ├── roles.decorator.ts │ │ └── roles.guard.ts │ ├── quiz/ │ │ ├── controllers/ │ │ │ ├── option.controller.ts │ │ │ ├── question.controller.ts │ │ │ ├── quiz.controller.ts │ │ │ └── response.controller.ts │ │ ├── dto/ │ │ │ ├── create-option.dto.ts │ │ │ ├── create-question.dto.ts │ │ │ └── create-quiz.dto.ts │ │ ├── entities/ │ │ │ ├── option.entity.ts │ │ │ ├── question.entity.ts │ │ │ └── quiz.entity.ts │ │ ├── events/ │ │ │ └── response-add.event.ts │ │ ├── quiz.module.ts │ │ ├── repositories/ │ │ │ ├── option.repository.ts │ │ │ ├── question.repository.ts │ │ │ └── quiz.repository.ts │ │ └── services/ │ │ ├── option.service.ts │ │ ├── question.service.ts │ │ ├── quiz.service.ts │ │ └── response.service.ts │ ├── search/ │ │ ├── controllers/ │ │ │ └── search.controller.ts │ │ ├── dto/ │ │ │ └── search-movie.dto.ts │ │ ├── search.module.ts │ │ └── search.service.ts │ └── user/ │ ├── dto/ │ │ └── user-register.req.dto.ts │ ├── enums/ │ │ └── user.enum.ts │ ├── user.controller.ts │ ├── user.entity.ts │ ├── user.module.ts │ └── user.service.ts ├── test/ │ ├── app.e2e-spec.ts │ └── jest-e2e.json ├── tsconfig.build.json ├── tsconfig.json └── uploads/ └── .gitignore ================================================ FILE CONTENTS ================================================ ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2022 amitavdevzone Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: readme.md ================================================ # Quiz Manager app This is a sample application built for my Youtube series on Quiz manager application. The backend API is built using Nest JS - a popular Node JS framework. The concept of this app is to allow Users to register themselves and take different Quizes that have been created inside the application. There will be Admins who will be moderating the quizes and also reviewing the responses. ================================================ FILE: server/.editorconfig ================================================ root = true [*] charset = utf-8 end_of_line = lf insert_final_newline = true indent_size = 2 indent_style = space trim_trailing_whitespace = true ================================================ FILE: server/.eslintrc.js ================================================ module.exports = { parser: '@typescript-eslint/parser', parserOptions: { project: 'tsconfig.json', sourceType: 'module', }, plugins: ['@typescript-eslint/eslint-plugin'], extends: [ 'plugin:@typescript-eslint/recommended', 'prettier/@typescript-eslint', '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', }, }; ================================================ FILE: server/.gitignore ================================================ # compiled output /dist /node_modules # Logs logs *.log npm-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 # Important secrets .env .env.prod # Uploads !uploads uploads/* ================================================ FILE: server/.prettierrc ================================================ { "singleQuote": true, "trailingComma": "all" } ================================================ FILE: server/README.md ================================================

Nest Logo

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 [circleci-url]: https://circleci.com/gh/nestjs/nest

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

## 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). ================================================ FILE: server/nest-cli.json ================================================ { "collection": "@nestjs/schematics", "sourceRoot": "src" } ================================================ FILE: server/package.json ================================================ { "name": "server", "version": "0.0.1", "description": "", "author": "", "private": true, "license": "UNLICENSED", "scripts": { "prebuild": "rimraf dist", "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", "typeorm:cli": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli -f src/config/typeorm.config-migrations.ts", "migration:generate": "npm run typeorm:cli -- migration:generate -d src/database/migrations -n", "migration:create": "npm run typeorm:cli -- migration:create -d src/database/migrations -n", "migration:run": "npm run typeorm:cli -- migration:run", "migration:revert": "npm run typeorm:cli -- migration:revert", "seed:config": "ts-node ./node_modules/typeorm-seeding/dist/cli.js config -n src/config/typeorm.config-migrations.ts", "seed:run": "ts-node ./node_modules/typeorm-seeding/dist/cli.js seed -n src/config/typeorm.config-migrations.ts", "db:refresh": "npm run typeorm:cli schema:drop && npm run migration:run && npm run seed:run" }, "dependencies": { "@nestjs/common": "^8.4.4", "@nestjs/config": "^2.0.0", "@nestjs/core": "^8.4.4", "@nestjs/event-emitter": "^1.1.0", "@nestjs/jwt": "^8.0.0", "@nestjs/passport": "^8.2.1", "@nestjs/platform-express": "^8.4.4", "@nestjs/swagger": "^5.2.1", "@nestjs/typeorm": "^8.0.3", "@ngneat/falso": "^5.0.0", "@types/bcrypt": "^5.0.0", "bcrypt": "^5.0.1", "class-transformer": "^0.5.1", "class-validator": "^0.13.2", "meilisearch": "^0.25.1", "mysql2": "^2.3.3", "nestjs-typeorm-paginate": "^3.2.0", "passport": "^0.5.2", "passport-jwt": "^4.0.0", "passport-local": "^1.0.0", "reflect-metadata": "^0.1.13", "rimraf": "^3.0.2", "rxjs": "^7.5.5", "swagger-ui-express": "^4.3.0", "typeorm": "^0.2.45", "typeorm-seeding": "^1.6.1" }, "devDependencies": { "@nestjs/cli": "^8.2.5", "@nestjs/schematics": "^8.0.10", "@nestjs/testing": "^8.4.4", "@types/express": "^4.17.13", "@types/jest": "^27.4.1", "@types/multer": "^1.4.7", "@types/node": "^17.0.25", "@types/passport": "^1.0.7", "@types/passport-jwt": "^3.0.6", "@types/passport-local": "^1.0.34", "@types/supertest": "^2.0.12", "@typescript-eslint/eslint-plugin": "^5.20.0", "@typescript-eslint/parser": "^5.20.0", "eslint": "^8.13.0", "eslint-config-prettier": "8.5.0", "eslint-plugin-prettier": "^4.0.0", "jest": "^27.5.1", "prettier": "^2.6.2", "supertest": "^6.2.2", "ts-jest": "^27.1.4", "ts-loader": "^9.2.8", "ts-node": "^10.7.0", "tsconfig-paths": "^3.14.1", "typescript": "^4.6.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" } } ================================================ FILE: server/src/app.controller.spec.ts ================================================ 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); }); describe('root', () => { it('should return "Hello World!"', () => { expect(appController.getHello()).toBe('Hello World!'); }); }); }); ================================================ FILE: server/src/app.controller.ts ================================================ import { Controller, Get, Post, UploadedFile, UseInterceptors, } from '@nestjs/common'; import { FileInterceptor } from '@nestjs/platform-express'; import { diskStorage } from 'multer'; import { extname } from 'path'; import { AppService } from './app.service'; @Controller() export class AppController { constructor(private readonly appService: AppService) {} @Get() getHello(): string { return this.appService.getHello(); } @Post('/file') @UseInterceptors( FileInterceptor('file', { storage: diskStorage({ destination: './uploads', filename: (req, file, callback) => { const uniqueSuffix = Date.now() + '-' + Math.round(Math.random() * 1e9); const ext = extname(file.originalname); const filename = `${uniqueSuffix}${ext}`; callback(null, filename); }, }), }), ) handleUpload(@UploadedFile() file: Express.Multer.File) { console.log('file', file); return 'File upload API'; } } ================================================ FILE: server/src/app.module.ts ================================================ import { MiddlewareConsumer, Module, NestModule, RequestMethod, } from '@nestjs/common'; import { ConfigModule } from '@nestjs/config'; import { TypeOrmModule } from '@nestjs/typeorm'; import { AppController } from './app.controller'; import { AppService } from './app.service'; import { typeOrmAsyncConfig } from './config/typeorm.config'; import { QuizModule } from './modules/quiz/quiz.module'; import { UserModule } from './modules/user/user.module'; import { AuthModule } from './modules/auth/auth.module'; import { ApiTokenCheckMiddleware } from './common/middleware/api-token-check.middleware'; import { EventEmitterModule } from '@nestjs/event-emitter'; import { SearchModule } from './modules/search/search.module'; import { MulterModule } from '@nestjs/platform-express'; @Module({ imports: [ ConfigModule.forRoot({ isGlobal: true }), TypeOrmModule.forRootAsync(typeOrmAsyncConfig), EventEmitterModule.forRoot(), MulterModule.register({ dest: './uploads' }), QuizModule, UserModule, AuthModule, SearchModule, ], controllers: [AppController], providers: [AppService], }) export class AppModule implements NestModule { configure(consumer: MiddlewareConsumer) { consumer .apply(ApiTokenCheckMiddleware) .forRoutes({ path: '/', method: RequestMethod.ALL }); } } ================================================ FILE: server/src/app.service.ts ================================================ import { Injectable } from '@nestjs/common'; @Injectable() export class AppService { getHello(): string { return 'Hello World!'; } } ================================================ FILE: server/src/app.utils.ts ================================================ import { HttpStatus, ValidationPipe } from '@nestjs/common'; const PASSWORD_RULE = /^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[#?!@$%^&*-]).{8,}$/; const PASSWORD_RULE_MESSAGE = 'Password should have 1 upper case, lowcase letter along with a number and special character.'; const VALIDATION_PIPE = new ValidationPipe({ errorHttpStatusCode: HttpStatus.UNPROCESSABLE_ENTITY, }); export const REGEX = { PASSWORD_RULE, }; export const MESSAGES = { PASSWORD_RULE_MESSAGE, }; export const SETTINGS = { VALIDATION_PIPE, }; ================================================ FILE: server/src/common/constants/event.constants.ts ================================================ export const events = { RESPONSE_SUBMITTED: 'response.submitted', }; ================================================ FILE: server/src/common/decorator/api-pagination.response.ts ================================================ import { applyDecorators, Type } from '@nestjs/common'; import { ApiExtraModels, ApiOkResponse, getSchemaPath } from '@nestjs/swagger'; import { PaginatedDto } from '../dto/paginated.dto'; interface IPaginatedDecoratorApiResponse { model: Type; description?: string; } export const ApiPaginatedResponse = >( options: IPaginatedDecoratorApiResponse, ) => { return applyDecorators( ApiExtraModels(PaginatedDto), ApiOkResponse({ description: options.description || 'Successfully received model list', schema: { allOf: [ { $ref: getSchemaPath(PaginatedDto) }, { properties: { items: { type: 'array', items: { $ref: getSchemaPath(options.model) }, }, meta: { type: 'any', default: { totalItems: 2, itemCount: 2, itemsPerPage: 2, totalPages: 1, currentPage: 1, }, }, }, }, ], }, }), ); }; ================================================ FILE: server/src/common/dto/paginated.dto.ts ================================================ interface PaginationMeta { totalItems: number; itemCount: number; itemsPerPage: number; totalPages: number; currentPage: number; } class PaginatedDto { items: TData[]; meta: PaginationMeta; } export { PaginationMeta, PaginatedDto }; ================================================ FILE: server/src/common/exceptions/api-token-payement.exception.ts ================================================ import { HttpException, HttpStatus } from '@nestjs/common'; export class ApiTokenPaymentException extends HttpException { constructor() { super('Token suggest payment is required', HttpStatus.PAYMENT_REQUIRED); } } ================================================ FILE: server/src/common/middleware/api-token-check.middleware.ts ================================================ import { NestMiddleware } from '@nestjs/common'; import { NextFunction, Request, Response } from 'express'; import { ApiTokenPaymentException } from '../exceptions/api-token-payement.exception'; export class ApiTokenCheckMiddleware implements NestMiddleware { use(req: Request, res: Response, next: NextFunction) { if (req.headers['api-token'] !== 'my-token') { throw new ApiTokenPaymentException(); } next(); } } ================================================ FILE: server/src/config/app.config.ts ================================================ export default () => ({ appSecret: process.env.APP_SECRET, }); ================================================ FILE: server/src/config/jwt.config.ts ================================================ import { JwtModuleAsyncOptions } from '@nestjs/jwt'; import appConfig from './app.config'; export const jwtConfig: JwtModuleAsyncOptions = { useFactory: () => { return { secret: appConfig().appSecret, signOptions: { expiresIn: '1d' }, }; }, }; ================================================ FILE: server/src/config/typeorm.config-migrations.ts ================================================ import { typeOrmConfig } from './typeorm.config'; export = typeOrmConfig; ================================================ FILE: server/src/config/typeorm.config.ts ================================================ import { ConfigModule, ConfigService } from '@nestjs/config'; import { TypeOrmModuleAsyncOptions, TypeOrmModuleOptions, } from '@nestjs/typeorm'; export const typeOrmAsyncConfig: TypeOrmModuleAsyncOptions = { imports: [ConfigModule], inject: [ConfigService], useFactory: async (): Promise => { return { type: 'mysql', host: process.env.DB_HOST, port: parseInt(process.env.DB_PORT, 10), username: process.env.DB_USERNAME, database: process.env.DB_NAME, password: process.env.DB_PASSWORD, entities: [__dirname + '/../**/*.entity.{js,ts}'], migrations: [__dirname + '/../database/migrations/*{.ts,.js}'], cli: { migrationsDir: __dirname + '/../database/migrations', }, extra: { charset: 'utf8mb4_unicode_ci', }, synchronize: false, logging: true, }; }, }; export const typeOrmConfig: TypeOrmModuleOptions = { type: 'mysql', host: process.env.DB_HOST, port: parseInt(process.env.DB_PORT, 10), username: process.env.DB_USERNAME, database: process.env.DB_NAME, password: process.env.DB_PASSWORD, entities: [__dirname + '/../**/*.entity.{js,ts}'], migrations: [__dirname + '/../database/migrations/*{.ts,.js}'], cli: { migrationsDir: __dirname + '/../database/migrations', }, extra: { charset: 'utf8mb4_unicode_ci', }, synchronize: false, logging: true, }; ================================================ FILE: server/src/database/data/quiz.data.ts ================================================ interface ISampleData { quizTitle: string; quizDescription: string; questions: Array; } interface IQuestionData { question: string; options: Array<{ text: string; isCorrect: boolean }>; } export const quizSampleData: Array = [ { quizTitle: 'Laravel beginner level quiz', quizDescription: 'In this quiz, you are going to be asked some basic questions which will target your knowledge of Laravel', questions: [ { question: 'How to put Laravel applications in maintenance mode?', options: [ { text: 'php artisan maintenance:on', isCorrect: false }, { text: 'php artisan down', isCorrect: true }, { text: 'php artisan maintenance:up', isCorrect: false }, { text: 'php artisan maintenance:down', isCorrect: false }, ], }, { question: 'What is the role of Service provider?', options: [ { text: 'They allow Laravel to know about the packages which are present and how to bootstrap them', isCorrect: true, }, { text: 'They allow Laravel to provide services for individual modules', isCorrect: false, }, ], }, ], }, { quizTitle: 'React Js beginner level quiz', quizDescription: 'In this quiz, you are going to be asked some basic questions which will target your knowledge of React Js', questions: [ { question: 'How to put Laravel applications in maintenance mode?', options: [ { text: 'php artisan maintenance:on', isCorrect: false }, { text: 'php artisan down', isCorrect: true }, { text: 'php artisan maintenance:up', isCorrect: false }, { text: 'php artisan maintenance:down', isCorrect: false }, ], }, ], }, ]; ================================================ FILE: server/src/database/factories/quiz.factory.ts ================================================ import { randDatabaseColumn, randParagraph, randSentence } from '@ngneat/falso'; import { define } from 'typeorm-seeding'; import { Quiz } from '../../modules/quiz/entities/quiz.entity'; define(Quiz, () => { const quiz = new Quiz(); quiz.title = randSentence(); quiz.description = randParagraph(); return quiz; }); ================================================ FILE: server/src/database/factories/user.factory.ts ================================================ import { randEmail, randFullName, randPassword } from '@ngneat/falso'; import { define } from 'typeorm-seeding'; import { User } from '../../modules/user/user.entity'; define(User, () => { const user = new User(); user.name = randFullName(); user.email = randEmail(); user.password = randPassword(); return user; }); ================================================ FILE: server/src/database/migrations/1649938237326-BaseMigrations.ts ================================================ import {MigrationInterface, QueryRunner} from "typeorm"; export class BaseMigrations1649938237326 implements MigrationInterface { name = 'BaseMigrations1649938237326' public async up(queryRunner: QueryRunner): Promise { await queryRunner.query(`CREATE TABLE \`users\` (\`id\` int NOT NULL AUTO_INCREMENT, \`name\` varchar(255) NOT NULL, \`email\` varchar(255) NOT NULL, \`password\` varchar(255) NOT NULL, \`createdAt\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6), \`updatedAt\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), UNIQUE INDEX \`IDX_97672ac88f789774dd47f7c8be\` (\`email\`), PRIMARY KEY (\`id\`)) ENGINE=InnoDB`); await queryRunner.query(`CREATE TABLE \`quizes\` (\`id\` int NOT NULL AUTO_INCREMENT COMMENT 'The quiz unique identifier', \`title\` varchar(255) NOT NULL, \`description\` text NOT NULL, \`isActive\` tinyint NOT NULL DEFAULT '1', PRIMARY KEY (\`id\`)) ENGINE=InnoDB`); await queryRunner.query(`CREATE TABLE \`questions\` (\`id\` int NOT NULL AUTO_INCREMENT, \`question\` varchar(255) NOT NULL, \`quizId\` int NULL COMMENT 'The quiz unique identifier', PRIMARY KEY (\`id\`)) ENGINE=InnoDB`); await queryRunner.query(`CREATE TABLE \`options\` (\`id\` int NOT NULL AUTO_INCREMENT, \`text\` varchar(255) NOT NULL, \`isCorrect\` tinyint NOT NULL, \`questionId\` int NULL, PRIMARY KEY (\`id\`)) ENGINE=InnoDB`); await queryRunner.query(`ALTER TABLE \`questions\` ADD CONSTRAINT \`FK_35d54f06d12ea78d4842aed6b6d\` FOREIGN KEY (\`quizId\`) REFERENCES \`quizes\`(\`id\`) ON DELETE NO ACTION ON UPDATE NO ACTION`); await queryRunner.query(`ALTER TABLE \`options\` ADD CONSTRAINT \`FK_46b668c49a6c4154d4643d875a5\` FOREIGN KEY (\`questionId\`) REFERENCES \`questions\`(\`id\`) ON DELETE NO ACTION ON UPDATE NO ACTION`); } public async down(queryRunner: QueryRunner): Promise { await queryRunner.query(`ALTER TABLE \`options\` DROP FOREIGN KEY \`FK_46b668c49a6c4154d4643d875a5\``); await queryRunner.query(`ALTER TABLE \`questions\` DROP FOREIGN KEY \`FK_35d54f06d12ea78d4842aed6b6d\``); await queryRunner.query(`DROP TABLE \`options\``); await queryRunner.query(`DROP TABLE \`questions\``); await queryRunner.query(`DROP TABLE \`quizes\``); await queryRunner.query(`DROP INDEX \`IDX_97672ac88f789774dd47f7c8be\` ON \`users\``); await queryRunner.query(`DROP TABLE \`users\``); } } ================================================ FILE: server/src/database/migrations/1651075479367-add_user_role_column.ts ================================================ import {MigrationInterface, QueryRunner} from "typeorm"; export class addUserRoleColumn1651075479367 implements MigrationInterface { name = 'addUserRoleColumn1651075479367' public async up(queryRunner: QueryRunner): Promise { await queryRunner.query(`ALTER TABLE \`users\` ADD \`role\` enum ('admin', 'member') NOT NULL DEFAULT 'member'`); } public async down(queryRunner: QueryRunner): Promise { await queryRunner.query(`ALTER TABLE \`users\` DROP COLUMN \`role\``); } } ================================================ FILE: server/src/database/seeds/setup-data.seed.ts ================================================ import { Connection, getManager } from 'typeorm'; import { Factory, Seeder } from 'typeorm-seeding'; import { Option } from '../../modules/quiz/entities/option.entity'; import { Question } from '../../modules/quiz/entities/question.entity'; import { Quiz } from '../../modules/quiz/entities/quiz.entity'; import { quizSampleData } from '../data/quiz.data'; export class SetupData implements Seeder { public async run(factory: Factory, connection: Connection): Promise { console.log('quizSampleData', quizSampleData); await getManager().query('SET foreign_key_checks = 0'); await getManager().query('TRUNCATE quizes'); await getManager().query('TRUNCATE questions'); await getManager().query('TRUNCATE options'); await getManager().query('SET foreign_key_checks = 1'); for (let i = 0; i < quizSampleData.length; i++) { const { quizTitle, quizDescription, questions } = quizSampleData[i]; const quiz = new Quiz(); quiz.title = quizTitle; quiz.description = quizDescription; await quiz.save(); for (let j = 0; j < questions.length; j++) { const { question, options } = questions[j]; const que = new Question(); que.question = question; que.quiz = quiz; await que.save(); for (let k = 0; k < options.length; k++) { const { isCorrect, text } = options[k]; const opt = new Option(); opt.isCorrect = isCorrect; opt.text = text; opt.question = que; await opt.save(); } } } } } ================================================ FILE: server/src/database/seeds/user-create.seed.ts ================================================ import { Connection, getManager } from 'typeorm'; import { Factory, Seeder } from 'typeorm-seeding'; import { UserRoles } from '../../modules/user/enums/user.enum'; import { User } from '../../modules/user/user.entity'; export class UserCreateSeed implements Seeder { public async run(factory: Factory, connection: Connection): Promise { await getManager().query('TRUNCATE users'); await factory(User)().create({ name: 'Amitav Roy', email: 'reachme@amitavroy.com', password: 'Password@123', role: UserRoles.ADMIN, }); // await factory(User)().createMany(20); } } ================================================ FILE: server/src/main.ts ================================================ import { NestFactory } from '@nestjs/core'; import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; import { AppModule } from './app.module'; async function bootstrap() { const app = await NestFactory.create(AppModule); app.enableCors(); const config = new DocumentBuilder() .addBearerAuth() .setTitle('Quiz manager API') .setDescription('Quiz manager API description') .setVersion('1.0') .build(); const document = SwaggerModule.createDocument(app, config); SwaggerModule.setup('api', app, document); await app.listen(process.env.PORT || 3000); } bootstrap(); ================================================ FILE: server/src/modules/auth/admin-role.guard.ts ================================================ import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'; import { Observable } from 'rxjs'; import { UserRoles } from '../user/enums/user.enum'; import { UserService } from '../user/user.service'; @Injectable() export class AdminRoleGuard implements CanActivate { constructor(private userService: UserService) {} async canActivate(context: ExecutionContext) { const request = context.switchToHttp().getRequest(); if (request?.user) { const { id } = request.user; const user = await this.userService.getUserById(id); return user.role === UserRoles.ADMIN; } return false; } } ================================================ FILE: server/src/modules/auth/auth.controller.ts ================================================ import { Body, Controller, Get, Post, Request, UseGuards, } from '@nestjs/common'; import { ApiBearerAuth, ApiTags } from '@nestjs/swagger'; import { AuthService } from './auth.service'; import { LoginDto } from './dto/login.dto'; import { JwtAuthGuard } from './jwt-auth.guard'; import { LocalAuthGuard } from './local-auth.guard'; @ApiTags('Auth') @Controller('auth') export class AuthController { constructor(private authService: AuthService) {} @UseGuards(LocalAuthGuard) @Post('login') async login(@Request() req, @Body() loginDto: LoginDto): Promise { return this.authService.generateToken(req.user); } @ApiBearerAuth() @UseGuards(JwtAuthGuard) @Get('user') async user(@Request() req): Promise { return req.user; } } ================================================ FILE: server/src/modules/auth/auth.module.ts ================================================ import { Module } from '@nestjs/common'; import { AuthService } from './auth.service'; import { AuthController } from './auth.controller'; import { LocalStrategy } from './local.strategy'; import { UserModule } from '../user/user.module'; import { PassportModule } from '@nestjs/passport'; import { JwtModule } from '@nestjs/jwt'; import { JwtStrategy } from './jwt.strategy'; import { jwtConfig } from '../../config/jwt.config'; @Module({ imports: [UserModule, PassportModule, JwtModule.registerAsync(jwtConfig)], providers: [AuthService, LocalStrategy, JwtStrategy], controllers: [AuthController], }) export class AuthModule {} ================================================ FILE: server/src/modules/auth/auth.service.ts ================================================ import { BadRequestException, Injectable, UnauthorizedException, } from '@nestjs/common'; import { UserService } from '../user/user.service'; import * as bcrypt from 'bcrypt'; import { JwtService } from '@nestjs/jwt'; @Injectable() export class AuthService { constructor( private userService: UserService, private jwtService: JwtService, ) {} async validateUserCreds(email: string, password: string): Promise { const user = await this.userService.getUserByEmail(email); if (!user) throw new BadRequestException(); if (!(await bcrypt.compare(password, user.password))) throw new UnauthorizedException(); return user; } generateToken(user: any) { return { access_token: this.jwtService.sign({ name: user.name, sub: user.id, }), }; } } ================================================ FILE: server/src/modules/auth/dto/login.dto.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { IsEmail, IsNotEmpty } from 'class-validator'; export class LoginDto { @ApiProperty({ description: 'Email address of the user', example: 'reachme@amitavroy.com', }) @IsNotEmpty() @IsEmail() username: string; @ApiProperty({ description: 'Password in plain text', example: 'Password@123', }) @IsNotEmpty() password: string; } ================================================ FILE: server/src/modules/auth/jwt-auth.guard.ts ================================================ import { Injectable } from '@nestjs/common'; import { AuthGuard } from '@nestjs/passport'; @Injectable() export class JwtAuthGuard extends AuthGuard('jwt') {} ================================================ FILE: server/src/modules/auth/jwt.strategy.ts ================================================ import { PassportStrategy } from '@nestjs/passport'; import { ExtractJwt, Strategy } from 'passport-jwt'; import appConfig from '../../config/app.config'; export class JwtStrategy extends PassportStrategy(Strategy) { constructor() { super({ jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(), secretOrKey: appConfig().appSecret, }); } async validate(payload: any) { return { id: payload.sub, name: payload.name, tenant: 'amitav', }; } } ================================================ FILE: server/src/modules/auth/local-auth.guard.ts ================================================ import { Injectable } from '@nestjs/common'; import { AuthGuard } from '@nestjs/passport'; @Injectable() export class LocalAuthGuard extends AuthGuard('local') {} ================================================ FILE: server/src/modules/auth/local.strategy.ts ================================================ import { Injectable, UnauthorizedException } from '@nestjs/common'; import { PassportStrategy } from '@nestjs/passport'; import { Strategy } from 'passport-local'; import { AuthService } from './auth.service'; @Injectable() export class LocalStrategy extends PassportStrategy(Strategy) { constructor(private authService: AuthService) { super(); } async validate(email: string, password: string) { const user = await this.authService.validateUserCreds(email, password); if (!user) throw new UnauthorizedException(); return user; } } ================================================ FILE: server/src/modules/auth/roles.decorator.ts ================================================ import { SetMetadata } from '@nestjs/common'; export const Roles = (...roles: string[]) => SetMetadata('roles', roles); ================================================ FILE: server/src/modules/auth/roles.guard.ts ================================================ import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'; import { Reflector } from '@nestjs/core'; import { UserService } from '../user/user.service'; @Injectable() export class RolesGuard implements CanActivate { constructor(private reflector: Reflector, private userService: UserService) {} async canActivate(context: ExecutionContext): Promise { const roles = this.reflector.get('roles', context.getHandler()); const request = context.switchToHttp().getRequest(); if (request?.user) { const { id } = request.user; const user = await this.userService.getUserById(id); return roles.includes(user.role); } return false; } } ================================================ FILE: server/src/modules/quiz/controllers/option.controller.ts ================================================ import { Body, Controller, Post, UsePipes, ValidationPipe, } from '@nestjs/common'; import { ApiBearerAuth, ApiCreatedResponse, ApiTags } from '@nestjs/swagger'; import { CreateOptionDto } from '../dto/create-option.dto'; import { Option } from '../entities/option.entity'; import { OptionService } from '../services/option.service'; import { QuestionService } from '../services/question.service'; @ApiTags('Questions') @ApiBearerAuth() @Controller('question/option') export class OptionController { constructor( private optionService: OptionService, private questionService: QuestionService, ) {} @Post('') @UsePipes(ValidationPipe) @ApiCreatedResponse({ description: 'The option that got created', type: Option, }) async saveOptionToQuestion(@Body() createOption: CreateOptionDto) { const question = await this.questionService.findQuestionById( createOption.questionId, ); const option = await this.optionService.creatOption(createOption, question); return { question, createOption, option }; } } ================================================ FILE: server/src/modules/quiz/controllers/question.controller.ts ================================================ import { Body, Controller, Get, Post, UsePipes, ValidationPipe, } from '@nestjs/common'; import { ApiBearerAuth, ApiCreatedResponse, ApiTags } from '@nestjs/swagger'; import { CreateQuestionDto } from '../dto/create-question.dto'; import { Question } from '../entities/question.entity'; import { QuestionService } from '../services/question.service'; import { QuizService } from '../services/quiz.service'; @ApiTags('Questions') @ApiBearerAuth() @Controller('question') export class QuestionController { constructor( private questionService: QuestionService, private quizService: QuizService, ) {} @Post('') @UsePipes(ValidationPipe) @ApiCreatedResponse({ description: 'Question added to a quiz', type: Question, }) async saveQuestion(@Body() question: CreateQuestionDto): Promise { const quiz = await this.quizService.getQuizById(question.quizId); return await this.questionService.createQuestion(question, quiz); } } ================================================ FILE: server/src/modules/quiz/controllers/quiz.controller.ts ================================================ import { Body, Controller, DefaultValuePipe, Get, Param, ParseIntPipe, Post, Query, UseGuards, UsePipes, ValidationPipe, } from '@nestjs/common'; import { ApiCreatedResponse, ApiOkResponse, ApiSecurity, ApiTags, } from '@nestjs/swagger'; import { IPaginationOptions, Pagination } from 'nestjs-typeorm-paginate'; import { ApiPaginatedResponse } from '../../../common/decorator/api-pagination.response'; import { AdminRoleGuard } from '../../auth/admin-role.guard'; import { JwtAuthGuard } from '../../auth/jwt-auth.guard'; import { Roles } from '../../auth/roles.decorator'; import { RolesGuard } from '../../auth/roles.guard'; import { CreateQuizDto } from '../dto/create-quiz.dto'; import { Quiz } from '../entities/quiz.entity'; import { QuizService } from '../services/quiz.service'; @ApiTags('Quiz') @Controller('quiz') @ApiSecurity('bearer') @UseGuards(JwtAuthGuard) export class QuizController { constructor(private quizService: QuizService) {} @Get('/') @ApiPaginatedResponse({ model: Quiz, description: 'List of quizzes' }) async getAllQuiz( @Query('page', new DefaultValuePipe(1), ParseIntPipe) page: number = 1, @Query('limit', new DefaultValuePipe(10), ParseIntPipe) limit: number = 1, ): Promise> { const options: IPaginationOptions = { limit, page, }; return await this.quizService.paginate(options); } @Get('/:id') @ApiOkResponse({ description: 'Get a quiz by id', type: Quiz }) async getQuizById(@Param('id', ParseIntPipe) id: number): Promise { return await this.quizService.getQuizById(id); } @ApiCreatedResponse({ description: 'The quiz that got created', type: Quiz }) @Post('/create') @UsePipes(ValidationPipe) @UseGuards(RolesGuard) @Roles('admin') async createQuiz(@Body() quizData: CreateQuizDto): Promise { return await this.quizService.createNewQuiz(quizData); } } ================================================ FILE: server/src/modules/quiz/controllers/response.controller.ts ================================================ import { Controller, Post } from '@nestjs/common'; import { EventEmitter2 } from '@nestjs/event-emitter'; import { ApiTags } from '@nestjs/swagger'; import { events } from '../../../common/constants/event.constants'; import { ResponseAddEvent } from '../events/response-add.event'; @Controller('/response') @ApiTags('Response') export class ResponseController { constructor(private eventEmitter: EventEmitter2) {} @Post('') async handleQuestionResponse() { // insert data into the response table console.log('This is inside the controller'); const payload = new ResponseAddEvent(); payload.userId = 1; payload.optionId = 33; this.eventEmitter.emit(events.RESPONSE_SUBMITTED, payload); return { message: 'Response taken' }; } } ================================================ FILE: server/src/modules/quiz/dto/create-option.dto.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { IsNotEmpty, Length } from 'class-validator'; export class CreateOptionDto { @ApiProperty({ description: 'The option for a question', example: 'Owl', }) @IsNotEmpty() @Length(2, 255) text: string; @ApiProperty({ description: 'The ID of the question', example: 1, }) @IsNotEmpty() questionId: number; @ApiProperty({ description: 'Whether the option is correct or not', example: true, }) @IsNotEmpty() isCorrect: boolean; } ================================================ FILE: server/src/modules/quiz/dto/create-question.dto.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { IsNotEmpty, Length } from 'class-validator'; export class CreateQuestionDto { @ApiProperty({ description: 'The actual question', example: 'A sample question', }) @IsNotEmpty() @Length(3, 255) question: string; @ApiProperty({ description: 'The quiz id to which the question is associated.', example: 1, }) @IsNotEmpty() quizId: number; } ================================================ FILE: server/src/modules/quiz/dto/create-quiz.dto.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { IsNotEmpty, Length } from 'class-validator'; export class CreateQuizDto { @ApiProperty({ description: 'The title of the quiz', example: 'How good are your with Laravel?', }) @IsNotEmpty({ message: 'The quiz should have a title' }) @Length(3, 255) title: string; @ApiProperty({ description: 'A small description for the user', example: 'This quiz will ask your questions on Laravel and test your knowledge.', }) @IsNotEmpty() @Length(3) description: string; } ================================================ FILE: server/src/modules/quiz/entities/option.entity.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { BaseEntity, Column, Entity, ManyToOne, PrimaryGeneratedColumn, } from 'typeorm'; import { Question } from './question.entity'; @Entity('options') export class Option extends BaseEntity { @ApiProperty({ description: 'Primary key as Option ID', example: 1 }) @PrimaryGeneratedColumn() id: number; @ApiProperty({ description: 'The actual option', example: 'Owl' }) @Column({ type: 'varchar', }) text: string; @ApiProperty({ description: 'Whether option is correct', example: true }) @Column({ type: 'boolean', }) isCorrect: boolean; @ManyToOne(() => Question, (question) => question.options) question: Question; } ================================================ FILE: server/src/modules/quiz/entities/question.entity.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { BaseEntity, Column, Entity, ManyToOne, OneToMany, PrimaryGeneratedColumn, } from 'typeorm'; import { Option } from './option.entity'; import { Quiz } from './quiz.entity'; @Entity('questions') export class Question extends BaseEntity { @ApiProperty({ description: 'The primary ID of question.', example: 1, }) @PrimaryGeneratedColumn() id: number; @ApiProperty({ description: 'The actual question', example: 'What is the question?', }) @Column({ type: 'varchar', }) question: string; @ApiProperty({ description: 'Quiz of the question', }) @ManyToOne(() => Quiz, (quiz) => quiz.questions) quiz: Quiz; @ApiProperty({ description: 'Options of the question', }) @OneToMany(() => Option, (option) => option.question) options: Option[]; } ================================================ FILE: server/src/modules/quiz/entities/quiz.entity.ts ================================================ import { ApiProperty } from '@nestjs/swagger'; import { BaseEntity, Column, Entity, OneToMany, PrimaryGeneratedColumn, } from 'typeorm'; import { Question } from './question.entity'; @Entity('quizes') export class Quiz extends BaseEntity { @ApiProperty({ description: 'Primary key as Quiz ID', example: 1 }) @PrimaryGeneratedColumn({ comment: 'The quiz unique identifier', }) id: number; @ApiProperty({ description: 'Title of the quiz', example: 'Sample Laravel quiz', }) @Column({ type: 'varchar', }) title: string; @ApiProperty({ description: 'Description of the quiz', example: 'Lorem ipsum', }) @Column({ type: 'text', }) description: string; @ApiProperty({ description: 'Quiz active or inactive state', example: true, }) @Column({ type: 'boolean', default: 1, }) isActive: boolean; @ApiProperty({ description: 'List of questions', }) @OneToMany(() => Question, (question) => question.quiz) questions: Question[]; } ================================================ FILE: server/src/modules/quiz/events/response-add.event.ts ================================================ export class ResponseAddEvent { userId: number; optionId: number; } ================================================ FILE: server/src/modules/quiz/quiz.module.ts ================================================ import { Module } from '@nestjs/common'; import { TypeOrmModule } from '@nestjs/typeorm'; import { QuestionController } from './controllers/question.controller'; import { QuestionRepository } from './repositories/question.repository'; import { QuestionService } from './services/question.service'; import { QuizController } from './controllers/quiz.controller'; import { QuizRepository } from './repositories/quiz.repository'; import { QuizService } from './services/quiz.service'; import { OptionRepository } from './repositories/option.repository'; import { OptionController } from './controllers/option.controller'; import { OptionService } from './services/option.service'; import { UserModule } from '../user/user.module'; import { ResponseController } from './controllers/response.controller'; import { ResponseService } from './services/response.service'; @Module({ controllers: [ QuizController, QuestionController, OptionController, ResponseController, ], imports: [ TypeOrmModule.forFeature([ QuizRepository, QuestionRepository, OptionRepository, ]), UserModule, ], providers: [QuizService, QuestionService, OptionService, ResponseService], }) export class QuizModule {} ================================================ FILE: server/src/modules/quiz/repositories/option.repository.ts ================================================ import { EntityRepository, Repository } from 'typeorm'; import { Option } from '../entities/option.entity'; @EntityRepository(Option) export class OptionRepository extends Repository