npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@exom-dev/captcha

v0.1.0

Published

Anti-robot challenges for Express.js

Downloads

6

Readme

Getting started

Installation

You can install Captcha just like any other npm package.

npm i @exom-dev/captcha --save

Usage

Simple example with sample dataset & javascript client

// server.js
const express = require('express');
const fs = require('fs');
const captcha = require('@exom-dev/captcha');

const app = express();

// Captcha needs json body parser to work
app.use(express.json());

// Setting up the dataset with captcha images
captcha.setOptions({ dataset: captcha.dataset.sample });
app.use('/captcha', captcha.dataset);

// Add captcha server routes
app.use('/captcha', captcha.server);

// Optionally host javascript client files
app.use('/captcha', captcha.client);

// Add your own routes
app.get('/register', (request, response) => {
  fs.createReadStream(__dirname + '/example.html').pipe(response);
});

app.post('/register', (request, response) => {
  if (captcha.consume(request.body['exm-captcha']) === true) {
    // everything okay
  }

  response.redirect('/register');
});

app.listen(80);
<!-- example.html -->
<!doctype html>
<html>
  <head>
    <!-- import captcha css file (default basic layout) -->
    <link href="/captcha/captcha.css" rel="stylesheet" type="text/css" />
  </head>
  <body>
    <form action="/register" method="post">
      <input type="text" name="username" placeholder="username" />
      <input type="password" name="password" placeholder="password" />
      <label>
        <!-- treat exm-captcha tag as being an checkbox-input -->
        <exm-captcha></exm-captcha>
        I'm not a robot
      </label>
      <input type="submit" />
    </form>

    <!-- import captcha js file (it uses web components) -->
    <script src="/captcha/captcha.js"></script>
  </body>
</html>

Options & defaults

captcha.setOptions({
  dataset: null,
  expires: 1000 * 60, // 1 minute
  solveIn: 1000 * 30, // 30 seconds
});

Create your own dataset

captcha.setOptions({
  dataset: [
    {
      category: 'any category you want',
      data: ['1', '2', '3', ...]
    },
    {
      category: 'another category',
      data: ['4', '5', '6', ...]
    },
    ...
  ]
});

Releases

0.1.0 - July 20th, 2020

License

This project was created by The Exom Developers.

The Captcha project is licensed under the MIT license.