SPINSPOT

Table of Contents

1. About The Project
2. Getting Started
3. Built With
4. API Info
   • Consumed
   • Exposed
5. Contributors

About The Project

• In an age of information overload, it's getting harder to trust the news. ANY news. A story breaking halfway around the world passes through reporters, editors, network executives, CEOs, and other stakeholders before it ever reaches your eyeballs. We may never know the whole truth, but learning to spot the motives behind the way a story is told can help us to get closer to it. We're not saying one news outlet is "better" or "worse" than any other; that's for you to decide. SPINSPOT is here for one thing: To show the differences in reporting, empowering readers to make up their own mind about the news. We are here for you to SPOT the SPIN in your daily news.
• This project mimics a service-oriented architecture where the back-end is responsible for consuming external API's and making the information avaiable by request to users through our front-end through our own API.
• Check out the Back-End at the SPINSPOT Back-End Repo
• Both repositories are accessible through Heroku:
  • Heroku Link - SPINSPOT BE
  • Heroku Link - SPINSPOT FE
• Turing Project Page

(back to top)

Getting Started

1. Fork and Clone the repo: GitHub - markertmer/news_app_fe
2. Install gem packages: bundle install
3. Setup the database: rails db:{create,migrate}
4. Get Mediastack API key here
5. Get TLDRThis API key here
6. Setup Figaro: bundle exec figaro install
7. Add API keys to config/application.yml

• mediastack_key: <put_your_key_here>
  tldr_key: <put_your_key_here>
  

(back to top)

Built With:

• Framework: Ruby on Rails
  • Versions
    • Ruby: 2.7.4
    • Rails: 5.2.6
• Database: PostgreSQL
• Other tech used:
  • CircleCI
  • Postman
  • RSpec
  • Boostrap

(back to top)

API Info:

Consumed:

• Mediastack
  • Used to retrieve news articles by passing sources and keywords to available endpoints.
  • Endpoints Used:
    • Live News: get http://api.mediastack.com/v1/news
    • Sources: get http://api.mediastack.com/v1/sources
• TLDRThis
  • Used to parse news articles by providing source-link and returns a summary of original article
  • Endpoints Used:
    • Human-like Article Summarization: post https://tldrthis.p.rapidapi.com/v1/model/abstractive/summarize-url/
    • Extractive Article Summarization: post https://tldrthis.p.rapidapi.com/v1/model/extractive/summarize-url/

Exposed:

• SPINSPOT

  • Available Endpoints:

    • get: /api/v1/news?keyword=<search_params>

  • Example Response:

    • 

(back to top)

Contributors

• Blake Dempsey
  
• Mark Ertmer
  
• Paul Leonard
  
• Ruben Pasillas
  
• Steven James
  
• Tamara Dowis
  

(back to top)