README.md 4.97 KB
Newer Older
yPhil's avatar
yPhil committed
1
# NeWS
yPhil's avatar
yPhil committed
2

yPhil's avatar
yPhil committed
3
*RSS/Atom morning news reader ; Works at night too.*
yPhil's avatar
yPhil committed
4

yPhil's avatar
yPhil committed
5
---
yPhil's avatar
yPhil committed
6

yPhil's avatar
yPhil committed
7
[![License GPLv3](https://img.shields.io/badge/license-GPL_v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html) [![Gratipay](http://img.shields.io/gratipay/yassinphilip.svg)](https://www.gratipay.com/yassinphilip/)
yPhil's avatar
yPhil committed
8

yPhil's avatar
yPhil committed
9
Read about it in French [ici](http://linuxfr.org/users/philippemc/journaux/avec-quoi-tu-lis-tes-rss-le-matin).
yPhil's avatar
yPhil committed
10

yPhil's avatar
yPhil committed
11
## NeWS is a personal track-free online RSS news reader
yPhil's avatar
yPhil committed
12

yPhil's avatar
yPhil committed
13
NeWS is a simple but powerful web app to view and manage various XML (RSS, aTom, etc) news feeds and present them in a nice, ergonomic fashion. I made it to replace the online news services (NetVibes, Google news, etc.) that I use up until around 2007, when they became bloated and **crippled with spyware**. It's a fast, simple and light system, and I've been using it for ~~weeks~~ years now ; It does what I want from a no-nonsense, every-morning-every-day news reader.
yPhil's avatar
yPhil committed
14

15
![NeWS screenshot](https://bitbucket.org/yassinphilip/nws/raw/master/img/screenshot.png)
yPhil's avatar
yPhil committed
16

yPhil's avatar
yPhil committed
17
18
19
20
21
### Practical Features

Make the page your home page, and read it every morning. You know instantly what article you've read ; We're already on the web, right? Just click and read the article. This is *so much better than TV*.

### Technical Features
yPhil's avatar
yPhil committed
22

yPhil's avatar
yPhil committed
23
24
- AJAX (asynchronous) loading of the feeds (ie reload one single feed w/o reloading the whole page)
- Flexible/Responsive rendering of the feeds wrapping
yPhil's avatar
yPhil committed
25
26
27
28
- Additionnaly, per tab/category:
    - Column mode
    - Block mode
    - Full block mode (for phones and small screens)
yPhil's avatar
yPhil committed
29
30
- Handles any charset encoding/langage
- Grabs the most out of the description text and displays it as standard tooltip on mouse hover
yPhil's avatar
yPhil committed
31
- Built-in **image gallery** (to view all the images in a feed, or in a category)
yPhil's avatar
yPhil committed
32
33
34
35
36
- Does its best to parse any given feed and identify it w/o questions
- Plays nice with different resolutions & ergonomics, ie phones, tablets, etc
- Directly links to any included image (and sound file)
- If any, displays item image, wrapped around text (displays it full width if it's the only item's element, or if it comes from a photoblog) 
- Lightweight and standard (valid HTML5 code)
yPhil's avatar
yPhil committed
37
38
39

### Installation

yPhil's avatar
yPhil committed
40
-   Copy the files in a directory within a webserver root, or just a directory on your local machine (but remember to install PHP)
yPhil's avatar
yPhil committed
41
-   Point your browser to that directory. That's it.
yPhil's avatar
yPhil committed
42
-   Oh, if you want to use the favicon caching feature (those favicons can take a loong time to get) make sure that the web server has the right to write to our directory:
yPhil's avatar
yPhil committed
43
    -   On the average web server (Debian / Apache) it's generally just a matter of, in the `nws` folder: `sudo chown .www-data .`
44
-   Recommended if installed online : Protect (restrict access to) the back-office / feeds file:
yPhil's avatar
yPhil committed
45
    -   Use [a trusted online htpassword generator](https://duckduckgo.com/?q%3Dhtpassword%2Bgenerator) (You can also create user/password pair(s) directly on the server with the command `htpasswd -b .access username password`)
yPhil's avatar
yPhil committed
46
    -   Paste this user/password pair in a file, and point to it from the [.htaccess](http://bitbucket.org/yassinphilip/nws/src/master/.htaccess) file
yPhil's avatar
yPhil committed
47

yPhil's avatar
yPhil committed
48
49
#### Annex: A simple local server

yPhil's avatar
yPhil committed
50
To run NWS locally, simply install a basic PHP server:
yPhil's avatar
yPhil committed
51

yPhil's avatar
yPhil committed
52
53
54
- Install the server components: `sudo apt install php7.0 php7.0-xml` (you may have to log in and out)
- Start the server in the NWS directory : `php -S localhost:8000`
- Point your browser to http://localhost:8000/nws
yPhil's avatar
yPhil committed
55

yPhil's avatar
yPhil committed
56
57
### Usage

yPhil's avatar
yPhil committed
58
59
60
-   Navigate the tabs with < left and > right arrow keys (and `r` & `t`)
-   Click the big "►" to view all the tab/category images in a gallery
-   Click the small, feed item's "►" to view all feed's images in a gallery
yPhil's avatar
yPhil committed
61
    -   Navigate the gallery's images with < left and > right arrow keys
yPhil's avatar
yPhil committed
62
    -   Exit the gallery by clicking outside it, or pressing the ESC key
yPhil's avatar
yPhil committed
63
64
65
66
67
68
-   Use the "Manage feeds" link to access the "back office"
    -   Use the "add a new feed" text entry field at the bottom to enter a new feed
    -   Use the "new tab" text entry field to create a new category
    -   Use the "change this feed's tab" menu to re-categorize the feed
    -   Use the "promote this feed" (^) link to bump up a feed as 1st of its tab
    -   Use the "delete this feed" (x) link to delete a feed
yPhil's avatar
yPhil committed
69
-   Or directly edit [libs/feeds.xml](http://bitbucket.org/yassinphilip/nws/src/master/libs/feeds.xml) (way **faster & safer**).
yPhil's avatar
yPhil committed
70
71
72
73
74
75
76
77
78
79
80
81
82
83

### LICENSE

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
yPhil's avatar
CDNs    
yPhil committed
84
along with this program.  If not, see <http://www.gnu.org/licenses/>.
85
86
87
88

*Icon by [Buuf](https://mattahan.deviantart.com/art/Buuf-37966044)*

---