Giter Club home page Giter Club logo

html-to-rss's Introduction

html-to-rss

This project aims to parse HTML page and generate a RSS feed from it. That's it. RSS is a great thing to have, whenever something changes in a website you will be notified. I don't want to go and check websites regularly. A computer/mobile device should do this, not me.

Installation

Get the latest release.

Usage

Environment variables:

  • KEMAL_ENV: (Optional) It's because this project uses Kemal. Options; development, production, test.
  • HTMLTORSS_HOST: (Optional) Hostname for generated urls. Example; HTMLTORSS_HOST='https://mywebsite.com'

You can use --help to get command line arguments.

Development

A new scraper needs to be in RssScrapers module, based on RssScrapers::BaseScraper and should be in src/scrapers/. After that, It needs to be registered in HtmlToRss::SCRAPER_TREE constant.

Testing

Scraper test scripts needs to be in spec/scrapers/. A new folder can be created for a scraper. One or more HTML examples can be located in this folder.

This project uses Kemal, so you need to test this with a environment variable:

$ KEMAL_ENV=test crystal spec

Contributing

  1. Fork it (https://github.com/thesseyren/html-to-rss/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

License

MIT

html-to-rss's People

Contributors

sseyren avatar

Stargazers

Samet Şahin avatar

Watchers

 avatar

Forkers

fpttelecomeduvn

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.