bookquotes

    1.2.0 • Public • Published

    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.
    const Line = require("bookquotes");
    console.log(Line.getLines()); // generates an object having a line, name of book and author.

    Output:

    {
      line: 'I had the epiphany that laughter was light, and light was laughter, and that this was the secret of the universe.',
      book: ' Donna Tartt',
      author: 'The Goldfinch'
    }
    
    • getLines(typeCode) method returns an object containing quote and author.
    const Line = require("bookquotes");
    console.log(Line.getLines("isp")); // generates an object having a line, name of book and author.
    • Type codes

      'isp' = inspire
      

      Output:

    {
      quote: 'When you start to love yourself for the first time, your scars start to look a lot more like beauty marks.',
      author: 'Jacob Tobia'
    }
    
    • getRandomLine() method returns a random aesthetic line!
    const Line = require("bookquotes");
    console.log(Line.getRandomLine()); // generates a single aesthetic line

    Output:

    All we have to decide is what to do with the time that is given us.
    
    • getRandomLine(typeCode) method returns a specific type random aesthetic line.
    const Line = require("bookquotes");
    console.log(Line.getRandomLine("isp"));
    • Type codes
    'isp' = inspire
    

    Output:

    When you start to love yourself for the first time, your scars start to look a lot more like beauty marks.
    

    Testing the package!

    forthebadge

    All the tests are in tests folder.

    • Install Jest using
    npm install --save-dev jest
    
    • Run the tests using
    npm test
    

    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

    Install

    npm i bookquotes

    DownloadsWeekly Downloads

    23

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    33.4 kB

    Total Files

    20

    Last publish

    Collaborators

    • anirudhpanda