authkey
self-hosted, bare-bones licensing API
Basically a very limited version of what keygen.sh does.
Quick start
-
configure Amazon SES or get some gmail creds
-
install
npm i authkey
- use
const authkey =
mailerConfig
options
service (type ) |
required credentials |
---|---|
amazonSES |
accessKeyId , secretAccessKey , region |
gmail |
user , pass |
API Reference
verb | endpoint | what it does |
---|---|---|
POST |
/request/:address |
creates a new auth key for the given address and sends an email with the auth key |
POST |
/verify/:authkey |
verifies the given auth key |
Database
a JSON file handled with lowdb
Versioning
SemVer is used (with help of semantic-release).
Contributing
git clone https://github.com/adekbadek/authkey.gitcd authkey/npm inpm t
Will install the dependencies and run tests in watch mode.
Tests
with Jest
npm t
Style guide
using Standard