Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
rnegron committed Feb 13, 2019
0 parents commit 1b1dfef
Show file tree
Hide file tree
Showing 19 changed files with 5,344 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
@@ -0,0 +1,15 @@
root = true

[*]
indent_style = space
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[{*.json,*.json.example}]
indent_style = space
indent_size = 4

[*.md]
trim_trailing_whitespace = false
85 changes: 85 additions & 0 deletions .gitignore
@@ -0,0 +1,85 @@
# Editors
.vscode
.idea

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
coverage.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/
3 changes: 3 additions & 0 deletions .npmignore
@@ -0,0 +1,3 @@
package-lock.json
.vscode
.idea
10 changes: 10 additions & 0 deletions .prettierrc
@@ -0,0 +1,10 @@
{
"trailingComma": "es5",
"semi": true,
"singleQuote": false,
"printWidth": 88,
"tabWidth": 2,
"useTabs": false,
"bracketSpacing": true,
"arrowParens": "avoid"
}
7 changes: 7 additions & 0 deletions .travis.yml
@@ -0,0 +1,7 @@
sudo: false
language: node_js
node_js:
- '10'
- '8'

after_success: npm run coverage
11 changes: 11 additions & 0 deletions CHANGELOG
@@ -0,0 +1,11 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.0.1] - 2019-02-08
### Added
-
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
## License (MIT)

Copyright (c) 2019 Raúl Negrón

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
73 changes: 73 additions & 0 deletions README.md
@@ -0,0 +1,73 @@
<h1 align="center">
noticias-pr
</h1>
<br>
<p align="center">
<!-- badges here -->
</p>

<p align="center"><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>

- [Demo](#demo)
- [Instalación](#instalación)
- [Uso](#uso)
- [Creditos](#creditos)
- [Licensia](#licensia)

## Demo

## Instalación

Asegurate tener [Node](https://nodejs.org/en/) versión 8 en adelante.

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

Con la opcíon `-g`, **npm** instalará `noticias-pr` globalmente, y el comando "`noticas-pr`" estará siempre accesible.

## Uso

```bash
noticias-pr
```

Luego, seguir las instrucciones desplegadas en el terminal.

Para navegar: usar las flechas del teclado.
Para aceptar: Utilizar el teclado de **enter** o **return**.

### Noticieros Disponibles

En orden de añadición:

1. El Nuevo Día: https://www.elnuevodia.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:

- [clear]() - Para limpiar el términal en determinados momentos.
- [ora]() - Para manejar los círculitos que dan vuelta mientras se espera.
- [kleur]() - Para colorizar el texto.
- [date-fns]() - Para manipular tiempo
- [mercury-parser]() - Para encontrar información de intrés en un artículo.
- [prompts]() - Para proveer interactividad en el terminal.
- [supports-color]() - Para verificar si el terminal permite desplegar colores.
- [terminal-image]() - Para desplegar imágenes en el terminal.
- [terminal-link]() - Para verificar y desplegar enlaces en el terminal.
- [update-notifier]() - Para notificar si hay versiones nuevas disponibles.
- [x-ray]() - Para navegar y descomponer páginas web y extraer su contenido.

## Licencia

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

<p align="center">
<br>
<img height="100" src="https://hechoen.pr/wp-content/themes/hepr/images/logo.png
" alt="Hecho en 🇵🇷" />

</p>
19 changes: 19 additions & 0 deletions TODO.md
@@ -0,0 +1,19 @@
## To-Do


- [ ] Añadir más sites
- [ ] noticel
- [ ] vocero
- [ ] primera hora
- [ ] índice
- [ ] etc...

- [ ] Poder utilizar proxies y otras configuraciones relacionadas al http

- [ ] Opciones para el tamaño del font, espacio, color, etc...

- [ ] Contribuir algunos [custom parsers](https://github.com/postlight/mercury-parser/tree/master/src/extractors/custom#custom-parsers)?

- [ ] Utilizar [conf](https://github.com/sindresorhus/conf) para almacenar posibles configuraciones

- [ ] Múltiples columnas usando [columnify](https://github.com/timoxley/columnify) o similar?

0 comments on commit 1b1dfef

Please sign in to comment.