README.md 4.49 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](https://petrolette.space) is a news home page, [Free, Libre, and Open-Source Software](https://framagit.org/yphil/petrolette/-/blob/master/LICENSE). She 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
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.
yPhil's avatar
yPhil committed
19
20
21

## Escape from GAFAM central

yPhil's avatar
yPhil committed
22
Pétrolette is fully self-contained, makes **no external call** whatsoever, and embarks a total of **zero tracker or "analysis" tool**. Needless to say she 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
29
- No ads, no trackers, **just the news**
- Displays all modern feeds (Atom, RSS 1/2, **MediaRSS**, etc.)
yPhil's avatar
yPhil committed
30
- New items indicator / badge
yPhil's avatar
yPhil committed
31
- **Video / Audio playing** directly in Pétrolette
yPhil's avatar
yPhil committed
32
- **Discovery of the feed** in a page / website
yPhil's avatar
yPhil committed
33
34
35
36
37
38
39
40
41
- Mobile / **phone** / tablet / responsive interface
- Direct link to all the article / item's resources (image, video, sound)
- **Search** within all the feeds
- Advanced image management (download, gallery, slideshow, etc.)
- Import / export of the tabs & 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
- Building of **Search terms feeds** [example](https://search.modalogi.com/searx/search?categories=news&language=en-US&format=rss&q=zombie,attack) using a configurable search engine
- Bookmarklet to **add the feed of any website to Pétrolette** on the fly
- Compatible with [FLOSS browsers](https://www.gnu.org/software/librejs/) (links to all uncompressed executable files, licenses available directly and in standard format)
yPhil's avatar
yPhil committed
42
43
44
45
46

## What's new?

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

47

yPhil's avatar
yPhil committed
48
### Install
yPhil's avatar
yPhil committed
49
50

```sh
yPhil's avatar
yPhil committed
51
git clone https://framagit.org/yphil/petrolette
yPhil's avatar
yPhil committed
52
53
54
cd petrolette
npm install
npm start
55
xdg-open http://localhost:8000
yPhil's avatar
yPhil committed
56
```
yPhil's avatar
yPhil committed
57
#### Update
yPhil's avatar
yPhil committed
58

yPhil's avatar
yPhil committed
59
60
61
62
```sh
cd petrolette
git pull
npm update
yPhil's avatar
yPhil committed
63
```
yPhil's avatar
yPhil committed
64
#### Test
yPhil's avatar
yPhil committed
65
66
67

```javascript
npm test
yPhil's avatar
yPhil committed
68
```
yPhil's avatar
yPhil committed
69

yPhil's avatar
yPhil committed
70
71
72
73
74
### Contributing

- Read the [development guidelines](https://framagit.org/yphil/petrolette/-/blob/master/DEV.md)
- Pétrolette is free software. However the development requires [a lot of time](https://www.youtube.com/watch?v=JlbMEx9H6FE) and [a lot of work](https://framagit.org/yphil/petrolette/-/commits/master). In order to keep developing it with new features I need your help ; Please consider to [support the Pétrolette project](https://liberapay.com/yPhil/donate) by sending a donation. Even the smallest amount will help a lot.

yPhil's avatar
yPhil committed
75
### LICENSE
yPhil's avatar
yPhil committed
76

yPhil's avatar
yPhil committed
77
78
79
80
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
81

yPhil's avatar
yPhil committed
82
83
84
85
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
86

yPhil's avatar
yPhil committed
87
88
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
89

yPhil's avatar
yPhil committed
90
*Icon by yPhil*
yPhil's avatar
yPhil committed
91

yPhil's avatar
yPhil committed
92
---