README.md 4.1 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)
5
6
7
[![Liberapay](https://img.shields.io/liberapay/receives/yPhil?logo=liberapay)](https://liberapay.com/yPhil/donate)
[![Liberapay](https://img.shields.io/liberapay/goal/yPhil?logo=liberapay)](https://liberapay.com/yPhil/donate)
[![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?label=buy+me+a&style=flat&logo=ko-fi&logoColor=white)](https://ko-fi.com/yphil/tiers)
yPhil's avatar
yPhil committed
8

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

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

yPhil's avatar
yPhil committed
13
[Pétrolette](https://petrolette.space) is a news home page, immediately usable **without registration** with the **same URL** on the desktop or a mobile device.
yPhil's avatar
yPhil committed
14

yPhil's avatar
yPhil committed
15
16
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
17
Feeds - there's feeds for everything: Video channels, news sites, blogs, social media feeds, issue trackers, etc. - 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
18
19
20

## Escape from GAFAM central

yPhil's avatar
yPhil committed
21
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
22

yPhil's avatar
yPhil committed
23
![Petrolette](https://yphil.bitbucket.io/images/petrolette.png)
24

yPhil's avatar
yPhil committed
25
## Features
26

yPhil's avatar
yPhil committed
27
28
- No ads, no trackers, **just the news**
- Displays all modern feeds (Atom, RSS 1/2, **MediaRSS**, etc.)
yPhil's avatar
yPhil committed
29
- New items indicator / badge
yPhil's avatar
yPhil committed
30
- **Video / Audio playing** directly in Pétrolette
yPhil's avatar
yPhil committed
31
- **Discovery of the feed** in a page / website
yPhil's avatar
yPhil committed
32
33
34
35
36
37
38
39
40
- 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
41
42
43
44
45

## What's new?

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

46

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

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

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

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

yPhil's avatar
yPhil committed
69
70
71
### Contributing

- Read the [development guidelines](https://framagit.org/yphil/petrolette/-/blob/master/DEV.md)
yPhil's avatar
yPhil committed
72
- Pétrolette is [Free, Libre, and Open-Source Software](https://framagit.org/yphil/petrolette/-/blob/master/LICENSE). 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
73

yPhil's avatar
yPhil committed
74
*Icon by yPhil*
yPhil's avatar
yPhil committed
75

76
Brought to you ♫ by [yPhil](http://yphil.bitbucket.io/) Please consider ♥ [helping](https://liberapay.com/yPhil/donate) icon by yPhil