authkey v1.4.0

authkey

self-hosted, bare-bones licensing API

Basically a very limited version of what keygen.sh does.

Quick start

1. configure Amazon SES or get some gmail creds

2. install

   npm i authkey

3. use

   const authkey = require('authkey')
   
   authkey({
     from: 'superthing@things.com'
     productName: 'SuperThing',
     mailerConfig: {
       // see below for other services
       type: 'gmail',
       credentials: {
         user: process.env.GMAIL_USER,
         pass: process.env.GMAIL_PASS,
       }
     },
   }).listen()

mailerConfig options

API Reference

Database

a JSON file handled with lowdb

Versioning

SemVer is used (with help of semantic-release).

Contributing

git clone https://github.com/adekbadek/authkey.git
cd authkey/
npm i
npm t

Will install the dependencies and run tests in watch mode.

Tests

with Jest

npm t

Style guide

using Standard