https://github.com/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.
https://github.com/m-ahmedk/authflow

authentication bcryptjs expressjs jwt mailgunjs pgsql postgres sequelize

Last synced: 5 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/m-ahmedk/authflow
• Owner: m-ahmedk
• License: mit
• Created: 2023-02-06T10:42:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-01T11:50:04.000Z (over 3 years ago)
• Last Synced: 2025-08-18T01:34:03.896Z (11 months ago)
• Topics: authentication, bcryptjs, expressjs, jwt, mailgunjs, pgsql, postgres, sequelize
• Language: JavaScript
• Homepage:
• Size: 78.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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 m.ahmedk287@gmail.com

## License

This project is licensed under the MIT License - see the [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/m-ahmedk/AuthFlow/blob/main/LICENSE) file for details.