Daftar Properti Listings Manager

This is the Listings Manager of Daftar Properti:

• Public web pages
• API backend for Listings Manager frontend
• Admin Panel for listings review

Development

Read Laravel 10.x.

One-time set up:

• Install composer for your OS
• Run composer install
• Set up local .env file (copy and edit from .env.example)
• Run php artisan key:generate

Running development server:

• Run php artisan serve
• development server listens at http://localhost:8000

Running static analyzer:

• Run vendor/bin/phpstan analyse

Running code style checker and fixer:

• /vendor/bin/phpcs --standard=PSR12 app
• /vendor/bin/php-cs-fixer fix

Running tests:

• Prepare test environment (see test-utils/)
• Run php artisan test

Admin Panel

Environment variables need to be set before building JS:

VITE_GOOGLE_MAPS_API_KEY
VITE_GOOGLE_MAP_ID

The admin panel requires JS to be built:

$ npm run build

Or for quick development, run vite with watch mode:

npx vite

Some useful environment variables when running vite behind reverse proxy:

VITE_HMR_PROTOCOL=wss            # if the reverse proxy uses HTTPS
VITE_HMR_HOST=<proxy-host-name>  # the name on which the proxy is accessible at
VITE_HMR_CLIENT_PORT=443         # port of the proxy, 443 if using default HTTPS port

Running tests in a container

To make it easy to run tests in an isolated environment, e.g. in a CI, a docker-compose is provided in test-env/.

1. Create necessary docker external resources:

$ docker network create global_network

2. Build image and run the container:

$ docker-compose -f test-env/docker-compose.yml build
$ docker-compose -f test-env/docker-compose.yml run test-app

Viewing Logs

Log destination can be configured by setting LOG_CHANNEL environment variable.

For local development, it's simplest to use LOG_CHANNEL=single or leave it unset. This will write logs to storage/logs/laravel.log.

For GCP deployment, set LOG_CHANNEL=gcp to utilize Google Cloud Logging as the log output. To view the logs in GCP console, go to Logs Explorer (https://console.cloud.google.com/logs), and filter the logs by the log name:

logName="projects/{project-name}/logs/app"

Laravel Queue

Daftar Properti uses Laravel Queues (https://laravel.com/docs/10.x/queues) to execute time-consuming tasks so that the main request handler does not block user requests, for example LLM execution, upload to cloud storage, etc.

In our app engine deployment, we use named queue (https://laravel.com/docs/10.x/queues#dispatching-to-a-particular-queue) so that each deployment version operates on the queue jobs that were posted by the same code version to avoid mismatched code between jobs and queue workers.

For now, we only operate one named queue for each version which is called generic-<version>. Due to the dynamic name of the queue, use App\Helpers\Queue::getQueueName() to generate the queue name with the correct version. For code reference, see additional-supervisord.conf.template.

Production Deployment

Production is deployed to Google App Engine, automated in a separate repo.