Giter Club home page Giter Club logo

neko's Introduction

Neko

Description

Neko is a personal feed reader that displays a "river of news."

It is intended for a single user. Put in your feeds, and it will track what you have read.

It also includes a "public" view of all items for you to share what you're reading with others.

It's a little rough around the edges and tough to install right now, but I've been using it for almost a year and wanted to share.

The cat ears are in your mind.

Demo: http://adamsneko.herokuapp.com

License

BSD, see LICENSE for details.

Requirements

python (tested with 2.7) See requirements.txt for required python modules.

Mongodb.

Installation

Clone the neko repo

> git clone [email protected]:adammathes/neko.git

Install python dependencies.

> pip install -r requirements.txt

Import your OPML. (optional)

> ./neko.py import feeds.opml

Run the crawler

> ./neko.py update

Run the web interface

> ./webneko.py

View it in a browser at http://127.0.0.1:9899

Running on Heroku

Clone the neko nepo.

> git clone [email protected]:adammathes/neko.git

Create a new herou app.

> heroku apps:create neko[somethingsomething]

Set up addons.

> heroku addons:add mongolab:starter
> heroku addons:add scheduler:standard

Check in your feed import to feeds.opml if you'd like.

Push it up.

> git push heroku master

Import your feeds.

> heroku run python neko.py import feeds.opml

Run the crawler

> heroku run python neko.py update

If you want, add that to your scheduler to autoupdate your feeds. (May cost $)

Auth

This is a total hack and will be improved.

Add a file called "auth" with a single line of username:password

Visit /login/ to sign in and /logout/ to sign out. (I know, I know.)

For Heroku, set environment vars.

> heroku config:set NEKO_USERNAME=user12345
> heroku config:set NEKO_PASSWORD=pass323423414

Customizing

Templates and css are in the static directory.

neko's People

Contributors

adammathes avatar

Watchers

James Cloos avatar  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.