m-ahmedk / AuthFlow

A project to create a secure and user-friendly system for user registration, login, and authorization. The system will allow users to sign up, log in, and access protected resources after proper authentication.

AuthFlow - Node.js Auth System with OTP + Postgres / Sequelize

This is a Node.js application that provides a secure and user-friendly system for user authentication and authorization, including login, registration, and OTP verification. It uses JWT for authentication and mailgun.js for sending OTP emails. It also includes a centralized error management system with Winston logger to record errors. The database used is Postgres and the ORM used is Sequelize.

Additionally, the project opens a Swagger documentation (http://localhost:3000/api-docs) which displays all the available requests, their description, and the methods.

Prerequisites

• Node.js
• npm

Getting Started

To get started, clone this repository and install the required dependencies using npm:

git clone https://github.com/m-ahmedk/AuthFlow.git

Navigate to the cloned repository:

cd authflow

Install dependencies:

npm install

Run the project:

npm run live

Open the Swagger documentation in your browser at http://localhost:3000/api-docs

Built With

Node.js Express Sequelize Mailgun.js BcryptJs Winston Swagger Yamljs

Contributing

If you would like to contribute to the project, please reach out to me at [e-mail]

License

This project is licensed under the MIT License - see the file for details.