Merge pull request #93 from hwgilbert16/develop

v1.1.0 Release

Author: hwgilbert16

.github/workflows/docker.yml

@@ -1,7 +1,8 @@
 name: Build and push image
 on:
   push:
-    branches: [release]
+    tags:
+      - '*'
 
 jobs:
   build:
@@ -37,6 +38,6 @@ jobs:
           context: .
           file: ./Dockerfile
           push: true
-          tags: ${{ secrets.DOCKER_USERNAME }}/scholarsome:latest
+          tags: ${{ secrets.DOCKER_USERNAME }}/scholarsome:latest,${{ secrets.DOCKER_USERNAME }}/scholarsome:${{ github.ref_name }}
 
 

README.md

@@ -24,7 +24,7 @@ https://scholarsome.com
 </p>
 
 <p align="center">
-<img src="https://i.imgur.com/MshTOaL.png">
+<img src="apps/docs/static/img/homepage.png">
 </p>
 
 ## About
@@ -37,17 +37,17 @@ You can read more about our design philosophy <a href="https://github.com/hwgilb
 
 ## Features
 
-Implemented features include:
-
-- Create your own study sets ✅
-- Import sets from Anki and Quizlet ✅
-- Study flashcards in multiple learning modes ✅
-- Create quizzes using fill-in-the-blank, true/false, and multiple choice questions ✅
-- Edit your sets ✅
-- Change set visibility ✅
-
-<img src="https://i.imgur.com/Xey0pzK.gif" width="50%">
-<img src="https://s12.gifyu.com/images/SWNMa.gif" width="50%">
+- Create your own study sets 🏗️
+- Share your sets with other users 🤝
+- Import sets from Anki, Quizlet, and CSV files 🔼
+- Export sets to Anki, Quizlet, and CSV files 🔽
+- Study flashcards in multiple learning modes, mimicking real-world flashcards 📖
+- Create quizzes using fill-in-the-blank, true/false, and multiple choice questions ✏️
+- Edit your sets 🛠️
+- Change set visibility 🔓
+
+<img src="https://s13.gifyu.com/images/S0cB1.gif" width="50%">
+<img src="https://s13.gifyu.com/images/S0cBD.gif" width="50%">
 
 ## Features coming soon...
 

apps/api/src/app/app.module.ts

@@ -16,9 +16,9 @@ import { CardsModule } from "./cards/cards.module";
 import { UsersModule } from "./users/users.module";
 import { RedisModule } from "@liaoliaots/nestjs-redis";
 import { JwtModule } from "@nestjs/jwt";
-import { APP_INTERCEPTOR } from "@nestjs/core";
-import { GlobalInterceptor } from "./auth/global.interceptor";
 import { MediaModule } from "./media/media.module";
+import { TokenRefreshMiddleware } from "./providers/token-refresh.middleware";
+import { ConvertingModule } from "./converting/converting.module";
 
 @Module({
   imports: [
@@ -68,15 +68,11 @@ import { MediaModule } from "./media/media.module";
         inject: [ConfigService]
       }),
       global: true
-    }
+    },
+    ConvertingModule
   ],
   controllers: [],
-  providers: [
-    {
-      provide: APP_INTERCEPTOR,
-      useClass: GlobalInterceptor
-    }
-  ],
+  providers: [],
   exports: [JwtModule]
 })
 export class AppModule implements NestModule {
@@ -92,5 +88,9 @@ export class AppModule implements NestModule {
           .apply(HttpsRedirectMiddleware)
           .forRoutes({ path: "*", method: RequestMethod.ALL });
     }
+
+    consumer
+        .apply(TokenRefreshMiddleware)
+        .forRoutes({ path: "*", method: RequestMethod.ALL });
   }
 }

apps/api/src/app/auth/auth.controller.spec.ts

@@ -7,7 +7,7 @@ import { Test } from "@nestjs/testing";
 import { ConfigService } from "@nestjs/config";
 import { UsersService } from "../users/users.service";
 import { RedisService } from "@liaoliaots/nestjs-redis";
-import { ThrottlerGuard, ThrottlerModule } from "@nestjs/throttler";
+import { ThrottlerModule } from "@nestjs/throttler";
 import { MailService } from "../providers/mail/mail.service";
 import { Request, Response } from "express";
 import { HttpException } from "@nestjs/common";
@@ -123,8 +123,7 @@ describe("AuthController", () => {
         {
           provide: RedisService,
           useValue: createMock<RedisService>()
-        },
-        ThrottlerGuard
+        }
       ],
       controllers: [
         AuthController

apps/api/src/app/auth/auth.controller.ts

@@ -15,7 +15,6 @@ import {
 import { UsersService } from "../users/users.service";
 import { AuthService } from "./auth.service";
 import { Response, Request as ExpressRequest } from "express";
-import { Throttle, ThrottlerGuard } from "@nestjs/throttler";
 import { ApiResponse, ApiResponseOptions } from "@scholarsome/shared";
 import { LoginDto } from "./dto/login.dto";
 import { RegisterDto } from "./dto/register.dto";
@@ -24,32 +23,24 @@ import * as jwt from "jsonwebtoken";
 import { ConfigService } from "@nestjs/config";
 import * as bcrypt from "bcrypt";
 import { MailService } from "../providers/mail/mail.service";
-import { RedisService } from "@liaoliaots/nestjs-redis";
-import Redis from "ioredis";
-import { JwtService } from "@nestjs/jwt";
 import { User } from "@prisma/client";
 import { ApiExcludeController, ApiTags } from "@nestjs/swagger";
+import { Throttle, ThrottlerGuard } from "@nestjs/throttler";
 
 @ApiTags("Authentication")
 @ApiExcludeController()
 @UseGuards(ThrottlerGuard)
 @Controller("auth")
 export class AuthController {
-  private readonly redis: Redis;
-
   /**
    * @ignore
    */
   constructor(
     private readonly usersService: UsersService,
     private readonly authService: AuthService,
     private readonly configService: ConfigService,
-    private readonly mailService: MailService,
-    private readonly jwtService: JwtService,
-    private readonly redisService: RedisService
-  ) {
-    this.redis = this.redisService.getClient();
-  }
+    private readonly mailService: MailService
+  ) {}
 
   /*
    * Password reset routes
@@ -145,10 +136,10 @@ export class AuthController {
   /**
    * Sends a password reset for a given user
    *
-   * @remarks Throttled to 1 request per minute
+   * @remarks Throttled to 1 request per 5 seconds
    * @returns Success response
    */
-  @Throttle(5, 60000)
+  @Throttle(1, 5)
   @Get("reset/sendReset/:email")
   async sendReset(
     @Param() params: { email: string }
@@ -262,10 +253,10 @@ export class AuthController {
   /**
    * Registers a new user
    *
-   * @remarks Throttled to 1 request per 3 minutes
+   * @remarks Throttled to 1 request per 5 seconds
    * @returns Success response
    */
-  @Throttle(5, 180000)
+  @Throttle(1, 5)
   @Post("register")
   async register(
     @Body() registerDto: RegisterDto,

apps/api/src/app/cards/dto/createCard.dto.ts

@@ -1,5 +1,7 @@
 import { IsNotEmpty, IsNumber, IsString } from "class-validator";
 import { ApiProperty } from "@nestjs/swagger";
+import { Transform, TransformFnParams } from "class-transformer";
+import * as sanitizeHtml from "sanitize-html";
 
 export class CreateCardDto {
   @ApiProperty({
@@ -24,6 +26,11 @@ export class CreateCardDto {
   })
   @IsString()
   @IsNotEmpty()
+  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
+    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
+    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
+    allowedSchemes: ["data"]
+  }))
     term: string;
 
   @ApiProperty({
@@ -32,5 +39,10 @@ export class CreateCardDto {
   })
   @IsString()
   @IsNotEmpty()
+  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
+    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
+    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
+    allowedSchemes: ["data"]
+  }))
     definition: string;
 }

apps/api/src/app/cards/dto/updateCard.dto.ts

@@ -1,5 +1,7 @@
 import { IsNotEmpty, IsNumber, IsOptional, IsString } from "class-validator";
 import { ApiProperty } from "@nestjs/swagger";
+import { Transform, TransformFnParams } from "class-transformer";
+import * as sanitizeHtml from "sanitize-html";
 
 export class UpdateCardDto {
   @ApiProperty({
@@ -18,6 +20,11 @@ export class UpdateCardDto {
   @IsString()
   @IsOptional()
   @IsNotEmpty()
+  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
+    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
+    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
+    allowedSchemes: ["data"]
+  }))
     term?: string;
 
   @ApiProperty({
@@ -27,5 +34,10 @@ export class UpdateCardDto {
   @IsString()
   @IsOptional()
   @IsNotEmpty()
+  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
+    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
+    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
+    allowedSchemes: ["data"]
+  }))
     definition?: string;
 }