Skip to main content

Developer notes

When working with multiple developers via version control, it is important to make sure you are up to date with:

  • Third party libraries
  • Database changes
  • System requirements

Updating Qore​

If you have the Qore CLI tool installed, you can update the front-end and the back-end to the latest version with the following command:

qore update

Useful development tools​

When creating resources, it may get really time consuming to fill out forms manually to test them.

If you install the qore/testing module, fields will be filled automatically.

See: https://qore.qlic.nl/modules/testing

Commands​

Here is a list of commands you may have to run:

Backend​

Install composer dependencies:

composer install

Migrate fresh + seed:

composer fresh

Frontend​

Install yarn dependencies:

yarn

Clearing vuex cache: Use the built-in button in the header CLEAR VUEX or:

this.$store.dispatch('globals/reset')
this.$store.dispatch('table/reset')

Debugging​

Back-end​

You can use the dd() helper in most situations. This will open a modal with the output dump.

Front-end​

For the front-end, you may use the $log() helper, which simply does a console.log(). The advantage of the $log() helper is that you can use it as a prop on a Vue component, because u dont have direct access to window.

Other tools​

PDF​

At this time of writing, the application makes use of barryvdh/laravel-snappy to export PDF files. To install wkhtmltopdf on MacOS run:

    brew install wkhtmltopdf

If you run into problems, see: https://github.com/barryvdh/laravel-snappy for more information.

For PDF options see: https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

Image editing​

Spatie media library is used for image editing. For example, favicons will automatically be resized when uploaded. In order to do this, it needs ImageMagick (see also config/image.php).

In order to make use of adjusting images in the back-end, you have to install ImageMagick (https://www.php.net/manual/en/book.imagick.php)

Geocoding & Zipcodes​

Both Google Cloud and https://www.postcodeapi.nu/ are used for address related fields.

To lookup Dutch postcodes, you should include the qore/postcode plugin.

To find international addresses via Google cloud, you should include the qore/geocoding plugin.

Both plugins should be configured with an API key on the Tenant plugin page.

Wysiwyg​

For the Wysiwyg field the TinyMce library is used for the editor. By default the Wysiwyg field is using a free api key. you can use your own key by adding a 'TINY_API_KEY' in your .env:

TINY_API_KEY=XXXX