/nimbo_rss

Primary LanguageJava

RSS Service codecov

A simple to use application for fetch data from news sites

Getting Started

For run this project on your own local machine or server you should install mysql and java and maven.

Prerequisites

For installing dependencies for this project do this instructions.

Install mysql

sudo apt install mysql-server

Install java

sudo apt install openjdk-8-jdk

Install maven

sudo apt install maven

Installing

After that edit the database.properties file in src/main/resources to your mysql user and run files on db directory to initialize database

database.username=root

database.password=password

Running the tests

The tests for database is working with h2 database and all tests will run by this command

mvn test

Usage

For working with the application run the jar file or run App in your own ide. This application will fetch data automatically by the news rate based on each site.

Most important queries:

search       Search in entries
add          Add a new site to repository
exit         Save data and exit
date-report  Report for each date for each site
hour-report  Report for each hour for each site

Examples:

search --title="The title" --content="The content"

date-report --title="The title"

For see full documentation for app and each command use --help ahead of that

Built With

  • SLF4J - The log API used
  • JOOQ - Used to generate queries
  • JSOUP - Used to fetch content of news
  • PICOCLI - Used to create Command Line Interface(CLI)
  • Maven - Dependency Management
  • ROME - Used to parse RSS Feeds

Authors

See also the list of contributors who participated in this project.