paduanton / news-feed-api

Back-end implementation of a news aggregator website that pulls articles from various sources and implements an algorithm over them to filter articles and authenticate users

Overview

News Feed is an open source project that implements a news aggregator website that pulls articles from various sources. It was developed in PHP using the Laravel Framework 10, MySQL database and MVC design pattern. This repository is the Restful API backend only. The frontend is written in ReactJS and can be seen here:

News Feed Frontend

Application Architecture

This API has the following entities: Users, FeedPreferences, OAuthAuthCodes, OAuthAccessTokens, OAuthRefreshTokens, OAuthClients, OAuthPersonalAccessClients and Migrations.

ER Database Diagram

(click the image to zoom it or just download the image and zoom it by yourself so you can see better all tables relationships)

Entity Relationship:

• Users 1 - N FeedPreferences
• Users N - OAuthAuthCodes - N OAuthClients
• Users N - OAuthAccessTokens - N OAuthClients
• OAuthAccessTokens 1 - 1 OAuthRefreshTokens
• OAuthPersonalAccessClients 1 - 1 OAuthClients
• PasswordResets

This application a couple of features such as user sign up, user log-in, retrieve user data, personalize news feed preferences and search for Articles in multiple sources like: NewsAPI.org, The Guardian and The New York Times.

System Requirements (Mac OS, Windows or Linux)

• Docker
• Docker Compose
• Composer

Project Setup

After clonning the repo, run the following commands on bash, inside the root directory:

Copy environment variables of the project: (Notice as this project supports API integration with NewsAPI.org, The Guardian and The New York Times , it means that you MUST set the the api keys for each one of these API's)

cp .env.example .env

Install project dependencies:

composer install

Build project artifacts:

docker-compose build --no-cache

Run project:

docker-compose up

Install dependencies and set directory permissions and cache:

docker exec -it feed-server-php_fpm /bin/sh bootstrap.sh

Notes:

• Remember to set all the API keys under .env file

After all these steps, the project will be running on port 8080: http://localhost:8080. All http requests send and receive JSON data.

To view changes in the database, go to http://localhost:8181/ on browser and you will be able to access phpmyadmin.

OAuth2 User Authentication:

In this API, through Laravel Framework it has been built an OAuth2 related authentication using the library Passport, then it's possible to consume server side authentication using JWT.

Notes:

In ./bootstrap.sh file are all the commands required to build this project, so, in order to make any changes inside the container, or if you wish to run any other commands, you must run this script and update this file further on if you need to.

• In all http requests you must provide the the headers Accept:application/json. In POST http requests you need to set the header Content-Type:application/json.

• After you hit the sign up or login endpoints, you will be able to get the access_token which will be required on further requests.

• In all http request (except Signup and Login) you need to provide the authentication header:

Authorization: Bearer eyJ0eXAiOiJKV1QiL.CJhbGciOiJSUzI1NiIm.p0aSI6Ic4ZDAwNG

Documentation

You can access the Restful API public documentarion in the link below or clicking here.

https://www.postman.com/paduanton/workspace/antonio-de-pdua-s-public-workspace/collection/5889563-b36b58e4-f3fc-4211-b41c-ecec2bf83545?ctx=documentation