/Web3Bridge

Primary LanguageTypeScript

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

This project is a Random Password Generator script built with NestJS and TypeScript. It generates random passwords of specified length and strength, containing a mix of uppercase letters, lowercase letters, numbers, and special characters. The project also includes test cases to ensure the functionality of the password generator.

Installation

$ git clone https://github.com/NikkyXO/Web3Bridge.git

$ cd Web3Bridge

$ npm install

$ npm run start:dev

$ View apis on swagger documentation at http://localhost:3008/api

Usage

The Random Password Generator can be accessed via a simple HTTP POST request. You can specify the length of the password and the inclusion of uppercase letters, numbers, and special characters through query parameters

API Endpoints

Generate Password

  • URL: /password/generate
  • Method: POST
  • Body Payload:
  • length (number, required): Length of the password (min: 4, max: 128). useUpperCase (boolean, optional): Include uppercase letters (default: false).
  • useNumbers (boolean, optional): Include numbers (default: false). useSpecialChars (boolean, optional): Include special characters (default: false).

Running the app

# development
$ npm run test

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

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.