guivinicius / fortune-api-nodejs

BSD Fortune API using Node.js and Express.js

A simple BSD Fortune API.

See the original one built using Ruby and Sinatra at http://github.com/guivinicius/fortune-api

Runnig the app

With NPM it's pretty simple.

  cd ~/YOUR_PATH/fortune-api-nodejs/
  npm start

Then go to http://localhost:3000/

Installing Fortune

The app is based on the Fortune program, so you will need it.

on Mac OS (with Homebrew)

  brew update
  brew install fortune

on Linux

  sudo apt-get update
  sudo apt-get install fortune

Using it

as JSON

  /fortune.json

as Text

  /fortune

Available Parameters

• long
  • 0 = only short fortunes (<= 160)
  • 1 = only longer fortunes (> 160)
  • nil = random
• dirty
  • 0 or nil = only non offensive fortunes
  • 1 = only offensive fortunes

Examples

as text

  /fortunes?long=1
  /fortunes?dirty=1
  /fortunes?dirty=1&long=1

result

  The difference between a career and a job is about 20 hours a week.

as json

  /fortunes.json?long=1
  /fortunes.json?dirty=1
  /fortunes.json?dirty=1&long=1

result

  {
    "text": "The difference between a career and a job is about 20 hours a week."
  }