Giter Club home page Giter Club logo

newsrack's Introduction

newsrack

Generate an online "newsrack" of periodicals for your ereader.

Features:

  • Download anywhere using your device browser
  • Subscribe via OPDS feeds

Uses calibre + recipes, GitHub Actions, and hosted on GitHub Pages.

eInk Kindle Screenshot Mobile Screenshot

Buy me a coffee

Running Your Own Instance

General Steps

  1. Fork this repository.
  2. Create a new branch, for example custom. Using a new branch makes a few things, like contributing fixes for example, easier.
  3. Add your own recipes to the recipes_custom/ folder and customise _recipes_custom.py. Optional.
  4. Customise the cron schedule and job run time in .github/workflows/build.yml. Optional.
  5. Set the new branch custom as default
    • from Settings > Branches > Default branch
  6. Enable Pages in repository settings to deploy from GitHub Actions
    • from Settings > Pages > Build and deployment > Source
  7. If needed, manually trigger the Build workflow from Actions to start your first build.

What Can Be Customised

newsrack supports extensive customisation such as:

  • add/remove recipes
  • the formats generated
  • when recipes are executed
  • cover colours and fonts

Review the wiki page to understand what can be customised and how to do so.

You can also refer to the example fork repo and see the actual customisations in action.

Available Recipes

newsrack has its own set of customised recipes. The full list of available recipes can be viewed on here.

newsrack's People

Contributors

ping avatar atiqzawad 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.