Git Product home page Git Product logo

bookquotes's Introduction

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

bookquotes's People

Contributors

anirudhpanda avatar aniketpathak028 avatar dipankarmaharana avatar prafulanand avatar d4rkener avatar vitorquadros avatar parthpanchal123 avatar nandan-shah avatar iamtamodip avatar saijyotitripathy avatar saif-malik-01 avatar muzammil-khan710 avatar miktoscano avatar mahich123 avatar kushank1207 avatar himanshuchandola-zz avatar greeshma2903 avatar gitaalekhyapaul avatar devrajdc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.