rnegron/noticias-pr-cli

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<h1 align="center">
 noticias-pr
</h1>
<br>
<p align="center">

![CI workflow](https://github.com/rnegron/noticias-pr-cli/actions/workflows/ci.yml/badge.svg)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d8700b46efaa7e08a8f1/test_coverage)](https://codeclimate.com/github/rnegron/noticias-pr-cli/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/d8700b46efaa7e08a8f1/maintainability)](https://codeclimate.com/github/rnegron/noticias-pr-cli/maintainability)
[![npm](https://img.shields.io/npm/v/noticias-pr.svg)](https://www.npmjs.com/package/noticias-pr)
![npm downloads](https://img.shields.io/npm/dt/noticias-pr)
[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)

</p>

<p align="center" width><code>noticias-pr</code> es una herramienta del command-line escrita en Node.js para navegar y leer noticias locales desde la comodidad de tu terminal.</p>

Esta aplicación fue creada con la intención de practicar NodeJS y para aprender como publicar un paquete en [npm](https://www.npmjs.com/package/noticias-pr).

- [Demo](#demo)
- [Instalación](#instalación)
- [Uso](#uso)
- [Créditos](#créditos)
- [Legal](#legal)
- [Licencia](#licencia)

## Demo

<p align="center"><img src="/img/cli-demo.gif" style="width: 20%; height: 20%"/></p>

## Instalación

Asegurate tener [NodeJS](https://nodejs.org/es/) versión `18` en adelante.

```bash
$ npm install -g noticias-pr
```

Con la opción `-g`, **npm** instalará `noticias-pr` globalmente, y el comando "`noticas-pr`" estará siempre accesible.

Alternativamente, puedes utilizar `npx` (ver: [npx vs npm exec](https://docs.npmjs.com/cli/v8/commands/npx#npx-vs-npm-exec))

```bash
$ npx noticias-pr
```

## Uso

Correr el siguiente comando en el terminal:

```bash
$ noticias-pr
```

Luego, seguir las instrucciones desplegadas en el terminal.

    Para navegar: Utilizar las flechas del teclado.
    Para aceptar: Utilizar la tecla de "enter" o "return".

### Noticieros Disponibles

En orden de añadición:

1. ~~El Nuevo Día: https://www.elnuevodia.com~~
2. ~~Primera Hora: https://www.primerahora.com~~
3. Noticel: https://www.noticel.com
4. El Vocero: https://www.elvocero.com

## Créditos

La applicación fue inspirada gracias a la existencia del [Mercury Parser](https://github.com/postlight/mercury-parser).

`noticas-pr` tiene las siguientes dependencias:

- [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) - Para utilizar varias funcionalidades en el terminal, tal y como limpiar la pantalla.
- [cfonts](https://github.com/dominikwilkowski/cfonts) - Para presentar un título gráfico al comenzar la applicación.
- [date-fns](https://github.com/date-fns/date-fns) - Para manipular el formato del tiempo.
- [html2plaintext](https://github.com/kurttheviking/html2plaintext) - Para convertir texto formateado en HTML a texto regular para depliegue en el terminal.
- [is-reachable](https://github.com/sindresorhus/is-reachable) - Para confirmar que la página web seleccionada está accesible a través del internet.
- [mercury-parser](https://github.com/postlight/mercury-parser) - Para encontrar información de intrés en un artículo.
- [ora](https://github.com/sindresorhus/ora) - Para manejar los círculitos que dan vuelta mientras se espera.
- [prompts](https://github.com/terkelg/prompts) - Para proveer interactividad en el terminal.
- [terminal-image](https://github.com/sindresorhus/terminal-image) - Para desplegar imágenes en el terminal.
- [terminal-link](https://github.com/sindresorhus/terminal-link) - Para verificar y desplegar enlaces en el terminal.
- [x-ray](https://github.com/matthewmueller/x-ray) - Para navegar y descomponer páginas web y extraer su contenido.

## Legal

Qué se yo, contáctame y resolvemos sin problema.

## Licencia

[MIT](LICENSE) &copy; [Raúl Negrón](https://raulnegron.me)

<p align="center">
<br>
    <img height="100" src="/img/pr.png" alt="Hecho en 🇵🇷" />
</p>