/auth-nestjs

Primary LanguageTypeScript

Nest Logo

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 Donate us Support us Follow us on Twitter

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Resources

Check out a few resources that may come in handy when working with NestJS:

  • Visit the NestJS Documentation to learn more about the framework.
  • For questions and support, please visit our Discord channel.
  • To dive deeper and get more hands-on experience, check out our official video courses.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • Need help with your project (part-time to full-time)? Check out our official enterprise support.
  • To stay in the loop and get updates, follow us on X and LinkedIn.
  • Looking for a job, or have a job to offer? Check out our official Jobs board.

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.

Stay in touch

License

Nest is MIT licensed.

API Routes Documentation

Roles and User Management

  • Sign Up (General): POST /auth/sign-up
    • Student: POST /auth/sign-up/student
    • Course Creators: POST /auth/sign-up/course-creator
    • Teaching Assistants: POST /auth/sign-up/teaching-assistant
    • Admin: POST /auth/sign-up/admin
    • Super Admin: POST /auth/sign-up/super-admin

MFA (Multi-Factor Authentication)

  • Sign In: POST /auth/mfa/sign-in
  • Enable MFA: POST /auth/mfa/enable
  • Disable MFA: POST /auth/mfa/disable
  • Verify Phone Number: POST /auth/mfa/verify-phone

Password Management

  • Forgot Password: POST /auth/forgot-password
  • Reset Password: POST /auth/reset-password
  • Update Password: PUT /auth/update-password

Account Management

  • Activate Account: POST /auth/activate-account
  • Update Phone Number: PUT /auth/update-phone
  • Verify Phone Number: POST /auth/verify-phone