Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ultirequiem/ranmess

đŸ’ģ Quotable Wrapper and CLI Tool
https://github.com/ultirequiem/ranmess

api-wrapper deno nodejs quotes random terminal typescript

Last synced: 3 months ago
JSON representation

đŸ’ģ Quotable Wrapper and CLI Tool

Awesome Lists containing this project

README

        

# ranmess

[![Code Coverage](https://codecov.io/gh/ultirequiem/ranmess/branch/main/graph/badge.svg)](https://codecov.io/gh/ultirequiem/ranmess)
[![Deno Doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/ranmess/mod.ts)

The most complete [Quotable](https://github.com/lukePeavey/quotable) API Wrapper
and CLI Tool.

> Quotable is a free, open source quotations API.

## Usage

The API is the same on all this platforms ✔ī¸

### [Deno đŸĻ•](https://deno.land/x/ranmess)

```javascript
import * as ranmess from "https://deno.land/x/ranmess/mod.ts";

ranmess.cleanQuote(); //=> "In seed time learn, in harvest teach, in winter enjoy."
ranmess.cleanQuote(); //=> "A leader is one who knows the way, goes the way, and shows the way."

ranmess.cleanTags(); //=> ["business", "education", "faith", "famous-quotes", ...etc]
```

### [Node.js đŸĸ🚀](https://npmjs.com/package/ranmess)

```javascript
import * as ranmess from "ranmess";
```

### [Browser 🌐](https://developer.mozilla.org/en-US/docs/Glossary/Browser)

You can use any [CDN](https://en.wikipedia.org/wiki/Content_delivery_network) đŸ”Ĩ

Eg 👉
[ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) ↔ī¸
[SkyPack](https://cdn.skypack.dev/ranmess) 🆚
[Script Tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script)
↔ī¸ [JSDelivr](https://cdn.jsdelivr.net/npm/ranmess)

## Documentation

Is hosted on
[Deno Doc](https://doc.deno.land/https://deno.land/x/ranmess/mod.ts) 📄

This module is fully typed, includes lot of utils and interfaces!

## CLI đŸ’ģ

### Install đŸ“Ļ

#### Deno

```sh
deno install --allow-net https://deno.land/x/ranmess/ranmess.ts
```

#### Node.js

```sh
npm install -g ranmess
```

[A binary for multiple platforms is provided too!](https://github.com/UltiRequiem/ranmess/releases/latest)
🤖

### Usage 🕹ī¸

```sh
ranmess
```

A random quote and its author will be printed!

[Video Showcase](https://youtu.be/42-AMus4olQ) đŸŽĨ

## Support

Open an Issue, I will check it a soon as possible 👀

If you want to hurry me up a bit
[send me a tweet](https://twitter.com/UltiRequiem) 😆

Consider [supporting me on Patreon](https://patreon.com/UltiRequiem) if you like
my work 🚀

Don't forget to star the repo ⭐

## Versioning

We use [Semantic Versioning](http://semver.org). For the versions available, see
the [tags](https://github.com/UltiRequiem/ranmess/tags) 🏷ī¸

## Other Art

I also made this on [Rust](https://github.com/UltiRequiem/ruquotes),
[Python](https://github.com/UltiRequiem/quoteran), and
[Go](https://github.com/UltiRequiem/quotable). Even a
[website](https://github.com/UltiRequiem/ulti-random-quotes)!

## Licence

Licensed under the MIT License 📄