Laravel Stock Price Aggregator

This is a Laravel showcase project. The app aggregates real-time stock price data from the Alpha Vantage API and provides comprehensive reporting functionalities for analyzing stock trends.

Table of contents

• Installation
• Quick start
• Documentation

Installation

!WARNING: Installation was tested only on macOS and based on the information from the official doc.

The application is using Laravel Sail for containerisation, so I assume you have Docker installed.

1. Clone the project

   git clone git@github.com:iggyster/laravel-stock-price-aggregator.git

2. Install composer packages:

   docker run --rm \
     -u "$(id -u):$(id -g)" \
     -v "$(pwd):/var/www/html" \
     -w /var/www/html \
     laravelsail/php83-composer:latest \
     composer install --ignore-platform-reqs

3. Copy .env.example into .env

   cp .env.example .env

4. Register an Alpha Vantage API Key and set in your .env file:

   ALPHA_VANTAGE_API_KEY=
   

5. Run sail (this step may take few minutes).

   ./vendor/bin/sail up -d

6. Run migrations.

   ./vendor/bin/sail artisan migrate

Quick start

To test implementation follow this steps:

1. Add ImportStocks job to the queue

   ./vendor/bin/sail artisan schedule:test

2. Run the queue worker

   ./vendor/bin/sail artisan queue:work --once

3. Go to the latest endpoint to see latest stocks.

Documentation

• Usage
• Design decisions
• Development notes