SCiO fairSCRIBE

The fairscribe project.

REQUIREMENTS

The project requires PHP 7.4/8.0 as well as Composer to be installed.

INSTALL THE DEPENDENCIES

cd scio-fairscribe-backend && composer install

BUILD THE DOCKER IMAGE

export WWWUSER=${WWWUSER:-$UID}
export WWWGROUP=${WWWGROUP:-$(id -g)}
cd docker && docker build -t laravelsail:php80-composer-mongodb . \
    --build-arg WWWGROUP=$WWWGROUP \
    --platform linux/amd64

NOTE: Works on Macbooks with ARM processors (M1/M1+) series as well.

CONFIGURE

cp .env.example .env

RUN THE BACKEND

./vendor/bin/sail up -d

STOP THE BACKEND

./vendor/bin/sail down

GENERATE A KEY AND A JWT SECRET

./vendor/bin/sail artisan key:generate
./vendor/bin/sail jwt:secret

RUN THE MIGRATIONS

To destroy the existing database and start fresh:

./vendor/bin/sail artisan migrate:fresh

SEED THE DATABASE

To seed the database with test data:

./vendor/bin/sail artisan db:seed

NOTE: In order to be able to seed the data, you need to modify your .env file and set your application environment to the following APP_ENV=local or APP_ENV=development.

LINK THE STORAGE FOR FILES

To link the storage for files:

./vendor/bin/sail artisan storage:link

NOTE: The storage for files should be linked in order for the backend to be able to serve files publicly.

CHANGE THE STORAGE DRIVER FOR S3

To change the storage driver, add the following settings:

FILESYSTEM_DRIVER=s3

AWS_ACCESS_KEY_ID="your-access-key-id"
AWS_SECRET_ACCESS_KEY="your-secret-key"
AWS_DEFAULT_REGION="your-region"
AWS_BUCKET="your-bucket-name"

CHANGE THE QUEUE DRIVER TO REDIS

To change the queue driver to redis, add the following settings:

QUEUE_CONNECTION=redis
REDIS_HOST=redis

SET THE CACHE CONFIGURATION

To set the cache configuration you need to change the following settings:

CACHE_TTL_SECONDS=3600

The default cache TTL of all the values is 1hr. The max cache recommended TTL is 12hr.

CONFIGURE PRESIGNED URLS

To set the expiration for all generated pre-signed urls change the following setting:

PRESIGNED_URL_TTL_IN_SECONDS=86400

IMPORTANT: This is used for PII check job as well as displaying the thumbnails and maybe in other places as well so make sure there is enough time for processing to happen or this may cause unexpected issues.

EXTERNAL SERVICE CONFIGURATION

To set the configuration for the third-party services (like SCiO or other):

SCIO_SERVICES_BASE_API_URL=https://scribe.api.dev2.scio.services/api
SCIO_SERVICES_CLIENT_ID=
SCIO_SERVICES_SECRET=
SCIO_CACHE_TOKEN_KEY=scio_token

RUN TESTS

To execute the test suites run:

./vendor/bin/pest

VIEW TEST COVERAGE

To view the test coverage report:

./vendor/bin/pest --coverage

AUTOCOMPLETION

If you add a dependency, _ide_helper.php will be auto-regenerated. If you change a model definition please run:

./vendor/bin/sail artisan ide-helper:models

and type no to update the model autocompletion file (_ide_helper_models.php).