Skip to content

Startpage server/client with reddit and todo feed

License

Notifications You must be signed in to change notification settings

roosta/startpage

Repository files navigation

Roosta's Startpage

Startpage displaying Reddit frontpage feed, org todo file and a ascii art clock in center. Both feeds are clickable and updates every minute. When clicking on a todo item emacsclient is called, opens file and jumps to location. Currently expects an emacs server to be running one way or another. (why wouldn't it be, right?)

Installation

Requires:

$ git clone https://github.com/roosta/startpage
$ cd startpage
$ npm install && script/build

Configuration

This startpage has a configuration file named config.edn To get started use the example config:

$ cat config.example.edn > config.edn

Config currently has three fields

:reddit-feed

contains the link to a reddit json feed, you can get this by going to reddit.com and going to preferences -> RSS feeds -> private listings, frontpage -> JSON copy that url and paste in config

:reddit-user

This is only used to create a unique "User-Agent" header value. Since we are populating the reddit feed using a GET request its good form according to reddit API documentation to craft a unique user-agent for that request.

:server-port

Pretty self explanatory, the example config uses port 80 since I'm hosting the example as a regular webpage, but it can be whatever you want.

:org-file

Physical location to an org file. Currently only supports absolute paths so it would be something like

:org-file "/home/[user]/TODOs.org"

App expects an org-mode todo file and only renders level one nodes. Example:

* TODO I'm a todo item
** IGNORED Level two nodes are not rendered
* DONE I'm a done todo item

Usage

$ script/run

Point your browser to http://localhost:<PORT>

License

Copyright © 2017 Daniel Berg

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

About

Startpage server/client with reddit and todo feed

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published