opentek-org/bookquotes

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

bookquotes

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!

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

Getting started

$ npm install --save bookquotes

Installation

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

• 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!

All the tests are in tests folder.

• Install Jest using

npm install --save-dev jest

• Run the tests using

npm test

Want to contribute?

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

Inspired by this project

bookquotes's Issues

Add Lines from your Favorite book

Do you like reading books and a line from the book just remained with you even after you have completed it?
Add that line to data.json inside the data/ folder and raise the PR.

   {  
      "line":"Your favorite lines",
      "book":"Book from which the line is",
      "author":"Author of the book"
   }

Let's share each other's best lines from our favorite book and meanwhile you will get to know a lot of books which may fascinate you.

Create bot greetings for first-time contributors

Problem Description

Greet the first-time contributors with an automated message, when they open a new issue or a PR for the first time.

I would like to take up this issue for Hacktoberfest 2021, if possible.

Change format in inspire.json

Description

Currently, we have inspire.json in the below format:

"line": "The moment you doubt whether you can fly, you cease forever to be able to do it.",
"book": "Per Pan",
"author": "J.M. Barrie"

Can we change it to:

"quote":
"author":

Ig we also have to change index.js accordingly to it. The reason is we just need inspirational quotes and not the book
CC: @gitaalekhyapaul @saif-malik-01

Screenshots

No response

Additional information

No response

Do you want to work on this issue?

• I want to work on this issue.

Add motivation section.

we can also include motivation quotes, whenever the user call getLines with 'mv' as an arguments is should return motivational quotes only or we can make a whole new function for that.

Background Image Feature?

Hi @AnirudhPanda

Suggestion

Maybe we can add features that combine quotes with image behind it?
Example

Source

We can using Jimp for image processing

Hashmap Function to generate new Lines after each retrieval from same client

[BUG] Improper implementation of the `randomInt()` function

Bug Description

The randomInt() function implemented is not valid for this use case. The function is shown below:

As per W3Schools this generates a random number between min and max (BOTH INCLUDED), which is causing the issue.

Since both min and max can be included, the code is crashing of index out of bounds error sometimes while testing, when the randomInt() returns max. A sample screenshot is given below:

Push the changes in the v1.2.0 branch instead of main for the next minor release

As our main branch is getting updated almost every day and it is also a good practice to make changes to a release branch and then merge the two branches at regular intervals eg; 15 days and then publish it to npm.

Please push the new changes to v1.2.0 branch instead of main and let's build this package the Open Source Way

FEATURE: Update README as per PR #59

#59

Add github actions

Use auto labeler to label the issues and PR with Hacktoberfest

Use this: https://github.com/marketplace/actions/labeler