Comical

If your users encounter a 404, lift their spirits by showing them a joke on the erro page. They might not like the error, but they'll love your product.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Make sure you have node in order to install this package.

Installing

Install the package:

npm install comical

Import the package to your project:

const comical = require("comical");

Now you can set the categories of jokes you would like to use. The catogories include: dad, stories, one liners. You set the categories using an array like this:

comical.setCategories(['dad','stories']);

In that case I wanted to exclude one liners.

Now I can display a random joke like this:

comical.getRandomJoke()

// Whenever the cashier at the grocery store asks my dad if he would like the milk in a bag he replies, 'No, just leave it in the carton!'

Wrap it in HTML and style it as you wish. Place it on your 404 page or wherever your users might like to read a joke. Enjoy!

License

This project is licensed under the MIT License - see the LICENSE.md file for details