Gettting Started

Installation (MacOS)

Client

Install the Angular CLI globally:

brew install angular-cli

Switch to the client folder

cd client

Install dependencies

npm install

Start the local development server

ng serve

TODO

Server

Install Composer

brew install composer

Switch to the server folder

cd server

Install dependencies

composer install

Add .env file from .env.example template

cp .env.example .env

Modify database credentials in .env

DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

Generate a new application key

php artisan key:generate

Run database migrations

php artisan migrate

Start the local development server

php artisan serve

Access server at http://localhost:8000

Development

Authorization

API Token Authentication

API Requirements

Required Send API request with Header -- Accept: application/json

Database

The server uses Polygon.io to retrieve stocks

Sign up for Polygon.io and fill out API key in .env file

POLYGON_API_KEY=

Run command below to seed the stocks table with available tickers

php artisan db:seed

Debugging

To monitor Laravel logs

tail -f storage/logs/laravel.log

Testing

Modify test database credentials in .env

DB_TEST_DATABASE=
DB_TEST_USERNAME=
DB_TEST_PASSWORD=

Run All Tests

php artisan test

Run All Tests in Parallel

php artisan test --parallel

Run Single Test

php artisan test --parallel --filter=UserTest