README.md 3.76 KB
Newer Older
yPhil's avatar
yPhil committed
1
# Pétrolette
yPhil's avatar
yPhil committed
2

yPhil's avatar
yPhil committed
3
[![pipeline status](https://framagit.org/yphil/petrolette/badges/master/pipeline.svg)](https://framagit.org/yphil/petrolette/-/pipelines)
yPhil's avatar
1.2.8    
yPhil committed
4
[![website](https://img.shields.io/website?down_message=down&up_color=brightgreen&up_message=up&url=https%3A%2F%2Fpetrolette.space)](https://petrolette.space)
yPhil's avatar
yPhil committed
5
6
[![Liberapay](https://img.shields.io/liberapay/receives/yPhil)](https://liberapay.com/yPhil/donate)
[![Liberapay](https://img.shields.io/liberapay/goal/yPhil)](https://liberapay.com/yPhil/donate)
yPhil's avatar
yPhil committed
7

yPhil's avatar
v1.2.8    
yPhil committed
8
9
---

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

yPhil's avatar
1.2.8    
yPhil committed
12
## Good morning! ☕ 📰
yPhil's avatar
yPhil committed
13

yPhil's avatar
yPhil committed
14
[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
15

yPhil's avatar
yPhil committed
16
17
Go ahead, it's yours : Create, delete, move feeds and tabs, close / quit your browser, come back tomorrow, everything is how you left it.

yPhil's avatar
yPhil committed
18
19
20
21
22
News feeds are organized into tabs, which can contain an infinite number of columns; everything is configurable, and saved directly in the browser [permanent cache](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). To view the same feeds on your phone, either export / import your `petrolette.conf` file, or (recommended) use the synchronization feature with your personal ([Google Drive](https://www.google.com/drive/), [Dropbox](https://www.dropbox.com/), [5apps](https://5apps.com/storage) (much better), etc.) cloud.

## Escape from GAFAM central

Pétrolette is fully self-contained, makes no external call whatsoever, and embarks a total of **zero tracker or "analysis" tool**. Needless to say it is also **completely ad-free**.
yPhil's avatar
yPhil committed
23

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

yPhil's avatar
yPhil committed
26
## Features
27

yPhil's avatar
yPhil committed
28
- No ads, no trackers, just the news
yPhil's avatar
v1.2.8    
yPhil committed
29
- Displays all modern feeds (Atom, Media-RSS, etc.)
yPhil's avatar
yPhil committed
30
- Mobile / phone / tablet / responsive interface
yPhil's avatar
yPhil committed
31
- Search within the feeds
yPhil's avatar
yPhil committed
32
- **Discovery of the feed** in a page / website
yPhil's avatar
yPhil committed
33
- Direct link to the article / item's resources (image, video, sound) for opening in an external reader
yPhil's avatar
yPhil committed
34
35
36
- Advanced image management (download, gallery, slidewhow, etc.)
- Import / export of the feeds file (replace / merge)
- Online synchronization ([5apps](https://5apps.com/storage), [Google Drive](https://www.google.com/drive/), [Dropbox](https://www.dropbox.com/)) on all your devices
yPhil's avatar
yPhil committed
37
- *Search* feeds [example](https://search.modalogi.com/searx/search?categories=news&language=en-US&format=rss&q=zombie,attack) using a configurable search engine
yPhil's avatar
yPhil committed
38
- Bookmarklet for adding the feed of any website to Pétrolette on the fly
yPhil's avatar
yPhil committed
39
40
41
42
43
44
- Compatible with [FLOSS browsers](https://www.gnu.org/software/librejs/) (uncompressed executable files, licenses available directly and in standard format)

## What's new?

Read [the changelog](https://framagit.org/yphil/petrolette/-/blob/master/CHANGELOG.md).

45

yPhil's avatar
yPhil committed
46
47
48
### Installation

```sh
yPhil's avatar
yPhil committed
49
git clone https://framagit.org/yphil/petrolette
yPhil's avatar
yPhil committed
50
51
52
cd petrolette
npm install
npm start
53
xdg-open http://localhost:8000
yPhil's avatar
yPhil committed
54

yPhil's avatar
yPhil committed
55
56
57
58
59
```
#### Testing

```javascript
npm test
yPhil's avatar
yPhil committed
60
```
yPhil's avatar
yPhil committed
61

yPhil's avatar
yPhil committed
62
### LICENSE
yPhil's avatar
yPhil committed
63

yPhil's avatar
yPhil committed
64
65
66
67
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
68

yPhil's avatar
yPhil committed
69
70
71
72
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
73

yPhil's avatar
yPhil committed
74
75
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
76

yPhil's avatar
yPhil committed
77
*Icon by yPhil*
yPhil's avatar
yPhil committed
78

yPhil's avatar
yPhil committed
79
---