kingdageek / news-buzz-api Goto Github PK

News Buzz is a news aggregator platform built on Laravel. This repo provides APIs that supports the platform.

There are three main entities:

• Datasources: External APIs that news are fetched from (this is entirely hidden from users)
• Sources: Actual News sources, some external APIs have several of these
• Categories: News sources categorize their articles

• Authentication: User login and registration
• User Roles: Just two currently available (READER & ADMIN) (see class App\Constants\UserRole)
• Preferences/Customization: User can choose which news sources and categories to see on their feed
• Newsfeed: News aggregated from the available data sources depending on chosen preferences
• Search & filter: News can be searched by search keyword and filtered using source, category, and date
• News Sources and Categories from different datasources can be fetched
• Datasources can be auto deactivated by admins
• Datasources, News Sources and Categories can be auto updated by admins
• Basic caching

The app uses Laravel sail that provides an easy way to run docker apps, so, you have to have Docker compose installed. All typical laravel console commands can be run in sail using ./vendor/bin/sail artisan CMD-NAME. The typical docker compose syntax still works too, in this case, you'd do: docker compose exec CONTAINER-NAME php artisan CMD-NAME.

STEPS

• copy the .env.example file to a .env file in the same base directory: cp .env.example .env
• IMPORTANT: Create an alias for sail for that bash session: alias sail=./vendor/bin/sail
• Run sail: sail up or in detached mode with sail up -d
• Generate app key: sail artisan key:generate
• Generate JWT secret: sail artisan jwt:secret
• Migrate the database: sail artisan migrate
• Seed the DB with the dummy admin: sail artisan db:seed (this can be skipped actually but then you can't currently create admins via the register endpoint)
• Get API keys from the external sources used (use links in External Sources below)
• Initialize the main entities: sail artisan app:update-main-entities

If there are no errors, then you're ready to go :) Explore the Routes! You should be able to fetch categories and sources now.

Three external sources are currently used:

• [https://newsapi.org/] NewsAPI
• [https://open-platform.theguardian.com/access/] The Guardian
• [https://developer.nytimes.com/] The New York Times

More external API sources can be easily added with little change to the existing codebase. To add a source:

• Include the config in the config/datasource.php file i.e. specify the base url, the api key etc exactly as the others are specified
• Create a client class for your external datasource in the app/DataSources directory. This client MUST implement the App\DataSources\DataSource interface. Here you query the API in its own required format, and ensure the response is parsed to suit the interface requirements
• Update Main Entities: sail artisan app:update-main-entities

Your source is ready to be used!