Coder Social home page Coder Social logo

1337nerd / startpage-2 Goto Github PK

View Code? Open in Web Editor NEW

This project forked from roosta/startpage

0.0 0.0 0.0 980 KB

Startpage server/client with reddit and todo feed

Home Page: http://startpage.roosta.sh

License: Eclipse Public License 1.0

Clojure 99.87% Shell 0.13%

startpage-2's Introduction

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.

startpage-2's People

Contributors

roosta avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.