LFUCG - Exactions

Lando with Docker

Be sure you have the latest release of Lando for local development. The .lando.yml at the root of the repo is the driving force behind setting things up.

https://docs.lando.dev/install

Trusting the Lando CA

Follow the instructions here to trust the local *.lndo.site SSL certificate.

Get up and running for the first time

Environment Variables

No environment variables are required to begin local development. In order to set optional environment variables found in backend/config/settings/base.py or backend/config/settings/local.py, copy .env.example to a new file named .env in the backend directory and add any variables you wish to set.

Lando

From the root directory of the project:

$ lando start

First time setup

Run Django migrations:

$ lando manage.py migrate

To add initial data, run:

$ lando manage.py loaddata -v 0 initial_data.json

To add groups, run:

$ lando manage.py loaddata -v 0 group_data.json

Add group permissions:

$ lando manage.py import_permissions

Add plats (though there may be errors with some):

$ lando manage.py import_plat import_files/plat_data.csv

Add lots (though there may be errors with some):

$ lando manage.py import_lot import_files/lot_data.csv

Add ledgers (though there may be errors with some):

$ lando manage.py ledger_add_delete_resolution

Create a super user for testing:

$ lando manage.py createsuperuser

Frontend

Build the frontend

$ lando npm run build

Workflow

To start the exactions server, use the following:

$ lando runserver
Performing system checks...

System check identified no issues (1 silenced).
May 23, 2024 - 23:51:48
Django version 1.11.29, using settings 'config.settings.local'
Starting development server at http://0.0.0.0:8000/
Quit the server with CONTROL-C.

If you make changes to the frontend, you will need to rebuild the frontend using the build script. alternatively, you can use the gulp script to watch for changes and rebuild the frontend automatically when changes are made. You must refresh the page to see the changes.

$ lando npm run gulp

The frontend is accessible at https://exactions.lndo.site. The admin site is accessible at https://exactions.lndo.site/admin.

Testing

Backend testing

$ lando django-test