Skip to content

joshferrell/hapi-license

Repository files navigation

Hapi License Hapi License

Greenkeeper badge

Join the chat at https://gitter.im/hapi-license/Lobby Build Status Coverage Status bitHound Dependencies

A licensing api that uses auth0 authentication. Give the licensing server machine information and the server will create a license for the user.

Getting Started

Before starting, you will first need to look at the .env.example file for your environment variables. To get up and running, simply duplicate the .env.example file to .env.

Install Application

yarn install

Run Application

yarn start

Available Commands

yarn start

Runs the app in development mode. Open http://localhost:3000/documentation to view documentation for the server in the browser.

The server will reload if you make edits.

View Server Documentation
View Interactive Server Logs

yarn test:spec --watchAll

Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.

Read more about testing

yarn lint

Runs the linting command, should be done before pull requests are made. This application follows the airbnb linting styleguide with minor changes.

Read more about the styleguide

yarn coverage

Runs the jest coverage command, checks the current code coverage of the application. The standard is keeping coverage above or at yellow status.

Docs

For further documentation, please read the wiki for information on interfacing with the api.

TODO

Create documentation about:

  • authentication token structure
  • manipulating license count in auth0

About

License management system for software

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published