a-sync / ocap-odata

OData API for OCAP data (ocap-stats database)

ocap-odata

About

• provides OData v4.01 API for ocap-stats database
• built on laravel 10 + loadata 2
• only a thin layer of eloquent models and lodata traits

Demo sites

fnf-odata.devs.space
  ⤷ using fnf-stats database
    ⤷ using OCAP2 data from FNF

Hosting requirements

• PHP 8.1 or later
• access to ocap-stats database (mysql/mariadb)

You should use env vars (env.example) to configure the database host/user/pw/dbname, but you only need to edit the DB_URL generally.

Development requirements

• docker-compose 2 or later
• composer 2.2 or later

Setup

Install composer dependencies.

composer install

Config

Create a .env file to enable laravel debug options.

APP_ENV=local
APP_KEY=
APP_DEBUG=true
LOG_LEVEL=debug

Running locally

⚠ You need to connnect to an existing ocap-stats database.
To quickly spin up your own local database head over to ocap-stats/SETUP.md for instructions.

Starting up the dev env:

docker-compose up

Services

• Web
  • http://localhost:8500/

Checking db connection

php artisan db:show

Shutting down the dev env

docker-compose down

Starting up the dev env again

docker-compose up -d

Clean restart

docker-compose down -v
docker system prune -a -f --volumes
composer install
php artisan route:clear
php artisan config:clear
php artisan cache:clear
docker-compose build --no-cache
docker-compose up -d