Skip to content

vaibhavpandeyvpz/passbird

Repository files navigation

passbird

Free, open-source client or server-side APIs to lint user input. Right now, you can check type for an email address i.e., either of disposable, free or business and determine strength for a given password on a scale of 1 to 5.

GitHub Workflow Status Codecov Codacy grade Code Climate maintainability

Installation

Make sure you have Node.js and Yarn installed on your workstation. Clone or download the repository and run below commands in project folder:

# install dependencies
yarn install

# start the local server
yarn start:dev

Deploy

Usage

The two endpoints included are as follows. You can also refer to the included Postman collection here for examples.

Method Path Description
GET / Lists supported endpoints
POST /email Checks for email type
POST /password Checks password strength

The Heroku powered, free-to-use base URL is https://passbird.herokuapp.com. Sample requests using curl would look like below:

curl -X POST -d "email=contact@vaibhavpandey.com" https://passbird.herokuapp.com/email

curl -X POST -d "password=Testing123" https://passbird.herokuapp.com/password

License

See LICENSE file.

About

Free, open-source client or server-side APIs to "lint" user input.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published