https://github.com/fooock/feed-reader
API server to share links with friends
https://github.com/fooock/feed-reader
Last synced: 2 months ago
JSON representation
API server to share links with friends
- Host: GitHub
- URL: https://github.com/fooock/feed-reader
- Owner: fooock
- License: other
- Created: 2017-10-28T22:49:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-06T21:00:03.000Z (about 8 years ago)
- Last Synced: 2025-02-12T05:56:54.473Z (11 months ago)
- Language: Go
- Homepage:
- Size: 19.5 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Feed Reader
This repo contains an API to share links between friends. All shared links are identified by the url and the author of the feed.
## Install
Clone this repo and compile it. When complete, execute:
```sh
./share-link-server -dev
```
This start the server in **debug** mode. To start it in release mode, start it without the *-dev* option.
You can apply two optional options:
* **-p**: Change the port. For default is listening in the port 8080
* **-x**: Change the host. For default is in 0.0.0.0
* **-d**: Sqlite database file. For default is in */tmp/feed-server.db*
## Endpoints
All endpoints use the `api/v1` prefix. Two endpoints are implemented:
* **GET** `/feeds`: Return a set of feeds in RSS format like:
```xml
OSPG links
0.0.0.0:8080
Interesting links about tech, hacking and more!
(Multiple authors)
Sun, 29 Oct 2017 12:37:48 +0100
https://beginners.re/
https://beginners.re/
newhouse
Sat, 28 Oct 2017 23:58:19 +0200
```
* **POST** `/feed`: Submit a new feed. The body is in `x-www-form-urlencoded`. An example:
```
curl -X POST \
http://localhost:8080/api/v1/feed \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'author=newhouse&feed=https%3A%2F%2Fbeginners.re%2F'
```
## Integrations
* **Newsbeuter**
Newsbeuter config file
```
macro y set browser "curl -X POST http://localhost:8080/api/v1/feed -H 'content-type: application/x-www-form-urlencoded' -d 'author=newhouse&feed=%u'"; open-in-browser ; set browser "$BROWSER %u"
```
Newsbeuter urls file
```
http://localhost:8080/api/v1/feeds
```
## License
```
Copyright 2017 newhouse (nhitbh at gmail dot com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```