Skip to content

ministryofjustice/fala

Folders and files

NameName
Last commit message
Last commit date

Latest commit

46284be · Dec 12, 2024
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Find a Legal Adviser

This repository holds the code for the "Find a legal aid adviser or family mediator" application. The service helps members of the public in England and Wales to search for a legal adviser or family mediator with a legal aid contract.

The website address is https://find-legal-advice.justice.gov.uk/.

Public API

The website uses the LAA Legal Adviser API. The code is hosted at https://github.com/ministryofjustice/laa-legal-adviser-api.

Dependencies

Prerequisites

Installation for development

.env

We need to do this for our developer settings, so please copy this file over if it doesn't exist and/or you're not using Docker.

You can use this command in your terminal or manually create a .env file:

cp .env.example .env

Playwright

Playwright is a tool for automating web browsers. It allows developers to write scripts to control web browsers and interact with web pages programmatically. It's often used for automated testing, web scraping, and browser automation tasks. We use it to test our end to end user journeys.

For local development and when using Playwright for the first time, run:

playwright install

This will install all required browser support required for Playwright to run.

We've configured Playwright to run with the rest of the app's tests i.e. by running ./manage.py test. If you'd like to edit any of the Playwright test settings for debugging purposes, for example running a headed browser, you can configure this in the setup file.

Docker

Please ensure your internet network such as your VPN does not interfere with your build.

To run container:

./run_local.sh

This shell script contains commands that build and runs the fala app.

If you're not using Docker Desktop, you may want to have two terminals open.

Tips for developing with docker containers

Code editing - You can edit the code on your local disk, with a local editor, as normal. (You don't have to edit the files inside the Docker container, because your local directory is mounted into container.) When you save a file, it becomes present in the container immediately, and the server restarts.

Browsing the app - Point your local browser at http://localhost:8013/

Log output - watch the output generated by the running app using: docker logs fala -f or docker attach fala

To exec into the Fala docker container, start a new terminal and perform the following:

docker exec -it fala bash

From the shell inside the container you can run some tests e.g.

python manage.py test

Alternatively, some editors have functionality to hook into running containers, such as VS Code's 'Dev Containers' extension. Docker Desktop offers a UI version of looking through logs, exec and many other interactions.

Debugging

Depending on how you're running the project, via venv or Docker you can perform the following debugging:

You can insert a breakpoint with the breakpoint() function at any position in your code.

If you're using a docker contain to run your project locally, you can run docker attach fala to view the output in your chosen terminal.

When breakpoint() is reached, you will be able to debug from the command line.

https://docs.python.org/3/library/pdb.html

Deploying to Staging and Production

The service uses helm to deploy to Cloud Platform Environments via CircleCI. This can be installed using:

brew install helm

To view helm deployments in a namespace the command is:

helm -n <namespace> ls --all

e.g. helm -n laa-fala-staging ls --all

Deployments can be deleted by running:

helm delete <name-of-deployment>

e.g. helm -n laa-fala-staging delete el-123-fee-change

It is also possible to manually deploy to an environment from the command line, the structure of the command can be found in bin/deploy.sh

Documentation