README.md

Authentication Service

Authentication Service is a Nest.js based rest api designed to provide authentication operations by Brew Interactive.

Purpose

The purpose of the project is to manage user authentication processes and securely register them. The main features of the project are:

1. User registration: An API endpoint is available for new users to register by entering their names, email addresses, and passwords.

2. User authentication: An API endpoint is available for users to log in using their email addresses and passwords to access the service.

3. JWT-based authentication: The project provides authentication functions using JSON Web Token (JWT) for secure user authentication.

4. Customizable: The structure and functions of the project can be customized to fit different use cases.

Authentication Service can be used in any project that requires user authentication functions, making it easy for projects to manage user accounts and securely register and log in users.

Documents

• Authentication Service Installation and Deployment
  • Deploying With Docker Compose
  • Installing the Service Package
• Local Development Instructions
  • Database Run With Docker
    • Run Postgres Database With Docker
  • Managing Database Migrations
    • Applying Migrations
    • Generating Migrations
  • Running Tests
• Environment Variables
• Plugin Development
  • Plugin Requirements
  • Creating Plugins
    • What can be done with Plugins?
    • Creating Token Claims Plugin
    • Creating User Registration Plugin
      • Pre User Registration
      • Post User Registration
    • Creating User Validator Plugin
    • Creating Template Plugin
  • Publishing a Plugin as a Package
  • Sample Plugin Projects
• API Reference

Conclusion

These instructions will help you start, configure, test, and use the authentication-service-nestjs project. The project can be used in any project that requires user authentication functions.

License

Authentication Service is MIT licensed.