Description

NestJS module containing Auth REST API endpoints for Quiz application.
Table of Contents:

API endpoints

• Check Admin password

How to use
How to develop

API endpoints

Check Admin password

${\textsf{\color{orange}POST}}$        https://{host}/quiz/password

REQUEST BODY

{
    password: string;
}

RESPONSE BODY

{
    isAdmin: boolean;
}

How to use

Install the package to the main NestJS application and add it to the main module imports:

import { AuthModule } from '@fellendorf/api-quiz-auth-module';

@Module({
  imports: [AuthModule],
  controllers: [],
  providers: [],
})

[!IMPORTANT] Main application must be connected to the MongoDB database.

How to develop

Repository contains an app module (src/_dev-only) just for development purposes. Additionally:

• command npm run build is set to use this main module to develop the "Questions" module;
• the folder containing the main module will not be included in the npm package (see .npmignore file)

[!NOTE] Using npm link command or file://... path in pacakge.json brings some bugs.

App TODO:

• TESTS