aq

awesome-quotes

A NodeJS module that returns awesome phrases and quotes

Showing:

Popularity

Downloads/wk

1

GitHub Stars

3

Maintenance

Last Commit

6yrs ago

Contributors

0

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Awesome Quotes

A small library providing awesome phrases and quotes to show in your application

Installation

npm install awesome-quotes --save

Usage

// Gets a random quote in the collection "computers" with the "english" language
var quotes = require('awesome-quotes');
quotes.getQuote('computers','en', function(err, data) {

    if(!err) {
        console.log(data);
    }

});

Each returned quote is a object containing:

  • text
  • author

Other Example

// Gets a random quote in the collection "computers" with the "brazilian portuguese" language
var quotes = require('awesome-quotes');
quotes.getQuote('computers','pt-br', function(err, data) {

    if(!err) {
        console.log(data);
    }

});

Using Collections

To use a collection, you must write it in lowercase, followed by the supported language. Example:

// Using the Computers Collection (a collection of programmers and computer scientists quotes)
quotes.getQuote('computers','pt-br', function(err, data) {

    if(!err) {
        console.log(data);
    }

});

Supported Collections and Languages

At this moment, the library supports these collections:

  • computers (a collection of programmers and computer scientists quotes)
    • en
    • pt
    • pt-br

Creating Collections

1. Create a directory in /quotes with the lowercase name of the collection
2. For each language, create a JSON file. Eg: en.json, pt-br.json, etc.

Contributing

You can modify the json archives in the /quotes directory to add more phrases and quotes, and can optimize my code, because it is my first node module, and it is very simple.

Release History

  • 0.1.0 Initial release
  • 0.1.2 Fix bugs
  • 0.2.1 Make library asynchronous

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial