README.md 2.74 KB
Newer Older
1
# Pétrolette
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
[![pipeline status](https://framagit.org/yphil/petrolette/badges/master/pipeline.svg)](https://framagit.org/yphil/petrolette/-/pipelines)
8
[![License GPLv3](https://img.shields.io/badge/license-GPL_v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
yPhil's avatar
yPhil committed
9
[![Liberapay](https://img.shields.io/badge/donate-Liberapay-yellow.svg)](https://liberapay.com/yPhil/donate)
yPhil's avatar
yPhil committed
10
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/yphil)
yPhil's avatar
yPhil committed
11

yPhil's avatar
yPhil committed
12
13
<!-- [![coverage](https://framagit.org/yphil/petrolette/badges/master/coverage.svg)](https://framagit.org/yphil/petrolette/-/pipelines) -->

yPhil's avatar
yPhil committed
14
15
## Welcome to the Internet

yPhil's avatar
yPhil committed
16
[Pétrolette](http://petrolette.space) is a news reading home page, [free](https://framagit.org/yphil/petrolette/-/blob/master/LICENSE). It is immediately usable **without registration** with the same URL on the desktop or a mobile device.
yPhil's avatar
yPhil committed
17

yPhil's avatar
yPhil committed
18
News feeds are organized into tabs, which can contain an infinite number of columns; everything is configurable, and saved directly in the browser cache. To view the same feeds on your phone, either export / import the `petrolette.conf` file, or (recommended) use the user's personal cloud synchronization feature.
yPhil's avatar
yPhil committed
19

yPhil's avatar
yPhil committed
20
![Petrolette](https://framagit.org/yphil/assets/-/raw/master/img/petrolette.png)
21

yPhil's avatar
yPhil committed
22
## Features
23

yPhil's avatar
yPhil committed
24
25
26
27
28
- Reads modern feeds (Atom, Media-RSS, etc.)
- Searches for feeds in a page / website
- Direct link to the article's resources (image, video, sound) for opening in an external reader
- Advanced image management
- Import / Export of the feeds file
yPhil's avatar
yPhil committed
29
- Online synchronization (5apps, Google Drive, Dropbox)
yPhil's avatar
yPhil committed
30
31
32
33
- Construction of web search feeds
- Mobile / responsive interface
- Bookmarklet for adding the feed of a site to Pétrolette on the fly
- Compatible with FLOSS browsers (uncompressed executable files, licenses available directly and in standard format)
34

yPhil's avatar
yPhil committed
35
36
37
### Installation

```sh
yPhil's avatar
yPhil committed
38
git clone https://framagit.org/yphil/petrolette
yPhil's avatar
yPhil committed
39
40
41
cd petrolette
npm install
npm start
tobias's avatar
tobias committed
42
43
# to use a custom port 
#PORT=XXXX npm start
yPhil's avatar
yPhil committed
44
xdg-open http://localhost:8000
yPhil's avatar
yPhil committed
45

yPhil's avatar
yPhil committed
46
47
48
49
50
```
#### Testing

```javascript
npm test
yPhil's avatar
yPhil committed
51
```
yPhil's avatar
yPhil committed
52

yPhil's avatar
yPhil committed
53
### LICENSE
yPhil's avatar
yPhil committed
54

yPhil's avatar
yPhil committed
55
56
57
58
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.
yPhil's avatar
yPhil committed
59

yPhil's avatar
yPhil committed
60
61
62
63
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.
yPhil's avatar
yPhil committed
64

yPhil's avatar
yPhil committed
65
66
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
yPhil's avatar
yPhil committed
67

yPhil's avatar
yPhil committed
68
*Icon by yPhil*
yPhil's avatar
yPhil committed
69

yPhil's avatar
yPhil committed
70
---