Skip to content
This repository has been archived by the owner on Nov 3, 2020. It is now read-only.

eink-news/eink.news

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 

Repository files navigation

eink.news

eink.news

App that allows you to do periodical or sporadic creation of ebooks with the content of a certain number of news websites and blogs.

Why?

Readability and availability. The best from ebooks and mobile phones. - " team members "

Supported sources

The current table displays the production ready sources, but other sources might be in development mode.

Source website epub sample kindle sample
Hacker News news.ycombinator.com download download
Ask Hacker News news.ycombinator.com/ask download download
IndieHackers indiehackers.com download download

Tech

eink.news uses a number of open source projects to work properly:

Installation

Install the dependencies and devDependencies.

$ cd eink.news
$ npm install

Create your env variables and edit them to fill your needs

$ cp .example.env .env

If you have a mac OS, you will also have to link the path where ebook-convert is stored to another path by doing:

$ ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin

Usage

eink.news can either be used for single bundle creations or to be deployed in a server that runs the cronjobs periodically.

To create a single bundle run:

$ PARSER=hackernews npm run parse

Where hackernews can be any source name without spaces and capital letters.

To start the server:

$ npm run start

To run the development server:

$ npm run dev

Testing: (no tests are specified yet)

$ npm run test

Development

Want to contribute? Great!

You should run the npm run dev command previously stated, which will track file changes and rerun the app when there's one.

You can contribute everywhere but we highly recommend creating or improving parsers. By doing so, you are adding more value to the users, which will be able to access more or better content.

For detailed instructions of how parsers work and how to create a new parser, go here.

License

MIT

About

Eink.news bundles creators

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published