An open API service indexing awesome lists of open source software.

https://github.com/leopku/micro-feed

Micro-Feed an extremely small size feed sync service with beautiful GUI, GraphQL support(also a graphql playground) support. https://github.com/leopku/micro-feed
https://github.com/leopku/micro-feed

docker feed graphql graphql-playground graphql-support rss-aggregator

Last synced: 4 months ago
JSON representation

Micro-Feed an extremely small size feed sync service with beautiful GUI, GraphQL support(also a graphql playground) support. https://github.com/leopku/micro-feed

Awesome Lists containing this project

README

          

# Micro Feed

Micro-Feed an extremely small size feed sync service with beautiful GUI, GraphQL support(also a graphql playground) support. https://github.com/leopku/micro-feed

## Q群

946315845

## Screenshot

![screenshot for micro-feed](https://raw.githubusercontent.com/leopku/micro-feed/master/c65633ca-f7d7-4315-ba50-650364d58df9.png)

## Features

### Micro Size

Extremely small binary size and docker image size.

Docker image size is <10MB.

### Supported feed types

* RSS 0.90
* Netscape RSS 0.91
* Userland RSS 0.91
* RSS 0.92
* RSS 0.93
* RSS 0.94
* RSS 1.0
* RSS 2.0
* Atom 0.3
* Atom 1.0

## Release

### Binary

https://github.com/leopku/micro-feed/releases

### Docker

[https://hub.docker.com/r/leopku/micro-feed-community](https://hub.docker.com/r/leopku/micro-feed-community)

## Docker

### Default

* app root: `/app`
* app config: `/app/micro-feed.toml`
* database: `/app/micro-feed.db`. This can be changed by modifing `/app/micro-feed.toml`

## GraphQL

### Playground

* `http://localhost:8300/graphql`

### Play with GraphQL

#### Add a feed

```
mutation {
createFeed(title: "my new feed", description: "feed detail", subscription: "https://path/of/my/feed/rss.xml")
}
```

After adding feed and waiting for a while (default 15min), entries would be synced from feed.

#### List Entries

```
query {
entries {
id
title
link
}
}
```

#### Get detail of an entry

```
query {
entry(id: 123) {
id
title
link
}
}
```

#### Mark an entry as read/unread

```
mutation {
markEntry(id: 123, mark: 1)
}
```

* `1` as read
* `2` as unread

## Issue reporting & Suggestion

### Telegram Channel

https://t.me/microfeed2019

### Telegram Group

https://t.me/joinchat/BTEzgBdAx6eQKVZj7mFPbA

### Github Issue

https://github.com/leopku/micro-feed/issues