Rosy03 / bookquotes

Generate lines, author, and book names from people's favorite books and also inspirational quotes!

Home Page:https://www.npmjs.com/package/bookquotes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

bookquotes

bookquotes

NPM VERSION GitHub license NPM MODULE npm collaborators GitHub issues npm downloads

A simple NPM Package which returns

  • random Lines from people's favorite book with names of the author as well as the book . It provides great and aesthetic quotes to display in your application.
  • random inspirational quotes. Get your daily quote and stay motivated!

If you like to read books, literature and want to stay motivated and inspired, this package is for you!

GitHub code size in bytes npm GitHub top language

Click here to view this package on NPM registry. Check the homepage here.

Getting started

NPM

$ npm install --save bookquotes

Installation

NPM INSTALL NODE JS inspirational-quotes

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

$ npm install bookquotes

Usage

usage

  • getLines() method returns an object containing line , book, and author.
{
  "line": "The gods grow jealous of too much contentment anywhere, and they show their displeasure all of a sudden.",
  "book": "Malgudi Days",
  "author": "R. K. Narayan"
}
  • getRandomLine() method returns a random aesthetic line!
const Line = require("bookquotes");

console.log(Line.getRandomLine()); // generates a single line

console.log(Line.getLines()); // generates an object having a line, name of book and author.
  • _getRandomLine(typeCode)_ method returns a specific type line.
const Line = require("bookquotes");

console.log(Line.getRandomLine("isp")); // for inspiring quote

console.log(Line.getLine("isp"));
  • Type codes

    'isp' = inspire
    

Testing the package!

forthebadge

All the tests are in tests folder.

Want to contribute?

Open Source Love PRs Welcome

Please check issues here!

Add Lines from your Favorite Books (Recommended for beginners)

Follow the JSON format and add your content(your favorite line from a book or an inspirational quote) in data file.

Please check HOW TO CONTRIBUTE here!

License

GitHub license Twitter Follow GitHub followers

forthebadge forthebadge forthebadge forthebadge forthebadge

Inspired by this project

About

Generate lines, author, and book names from people's favorite books and also inspirational quotes!

https://www.npmjs.com/package/bookquotes

License:MIT License


Languages

Language:JavaScript 100.0%