zxcvbn demo using Web Sockets
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Peter J. Jones 1af1cfd076
Add Docker image config and README info
2 months ago
images Add Docker image config and README info 2 months ago
src Change result type so it includes a strength value as a percent 2 months ago
www Let the meter pick colors for itself, add debugging info 2 months ago
.envrc Initial import 2 months ago
.gitignore Initial import 2 months ago
CHANGELOG.md Initial import 2 months ago
LICENSE Initial import 2 months ago
README.md Add Docker image config and README info 2 months ago
Setup.hs Initial import 2 months ago
default.nix Initial import 2 months ago
docker.nix Add Docker image config and README info 2 months ago
shell.nix Initial import 2 months ago
zxcvbn-ws.cabal Initial import 2 months ago
zxcvbn-ws.nix Initial import 2 months ago

README.md

screenshot

What?

This is a demo application for the Haskell zxcvbn-hs password strength estimation package. More information about zxcvbn and the Haskell implementation can be found at this repository.

How?

To play with this demo you need to:

  1. Either use the Docker image or build from source
  2. Start the service
  3. Go to http://localhost:12345/

Using the Docker Image

If you have Docker installed, using the Docker image is super simple:

$ docker run -p 127.0.0.1:12345:12345/tcp sthenauth/zxcvbn-ws

That will download the image and start the web server. Now just play with it at http://localhost:12345/.

Building from Source

If you have an existing Haskell toolchain installed then you can use cabal install. Otherwise keep reading.

  1. Install Nix which is pretty simple and straight forward.

  2. Open a new terminal and run the following command in the directory containing this file:

     $ nix-build
    
  3. Wait for everything to build.

  4. Start the web server:

     $ zxcvbn_ws_datadir=$(pwd) ./result/bin/zxcvbn-ws
    

Configuration

You can change the port that zxcvbn-ws uses by setting the ZXCVBN_PORT environment variable.