About This Project

This project is a Laravel-based application for fetching articles from various sources and serve them with the native API. Follow the instructions below to set up and run the project. Documentation of the API is inside /routes/api.php

Setting the environment for demonstration

Step 1: Clone the Repository

git clone https://github.com/ktsouvalis/articles.git
cd articles

Step 2: Install Dependencies

composer install

Step 3: Set Up Environment Variables

Copy the example environment file and set up your environment variables:

copy .env.example .env
php artisan key:generate

Inside the .env file, set your database connection details for MySQL or the path to your SQLite file.
Also set your enviroment variables for the sources:

GUARDIAN_API_URL=content.guardianapis.com/search
GUARDIAN_API_KEY=your-guardian-key
NYTIMES_API_URL=api.nytimes.com/svc/search/v2/articlesearch.json
NYTIMES_API_KEY=your-nytimes-key
NEWSAPI_API_URL=newsapi.org/v2/everything
NEWSAPI_API_KEY=your-news-api-key

Step 4: Run Migrations

Run the database migrations to set up the necessary tables:

php artisan migrate

Running the Application

You will need to run the following commands in three separate terminal windows:

Terminal 1: Start the Development Server

php artisan serve

Terminal 2: Start the Queue Worker

php artisan queue:work

Terminal 3: Run the Custom Command

php artisan app:call-sources <keeperClassName>

OR: Run the scheduler and wait until 6am or 6pm

php artisan schedule:work

Extending the Application

Pick an API source of your preference, and add a New Source in app/Services/Keepers/Keeper.php:

- Locate the `Keeper` class in your project.
- Add a new record to the sources array for your chosen API source. This will typically involve specifying the source name and any necessary configuration details. You have to study your choice's API Documentation

OR Create a new keeper class (if the first one becomes extremely large or if you need a different scheduling):

- Create a new keeper class inside `app/Services/Keepers/`
- The new class must implement SourceKeeper Interface
- Check the `app/Services/Keepers/Keeper.php` as an example

License

The project is licensed under the MIT license.