LocalGov Drupal

LocalGov Drupal is a distribution and install profile built to help UK councils publish public facing websites quicker, cheaper and better.

Find out more at https://localgovdrupal.org/

Read the docs at: https://docs.localgovdrupal.org/

It has been supported by:

• Ministry of Housing Communities and Local Government Local Digital Fund
• Brighton and Hove City Council
• Croydon Council
• Agile Collective

Active development is on Github:

https://github.com/localgovdrupal/localgov

Supported branches

We are actively supporting and developing the 3.x branch.

The 1.x branch is no longer actively supported and not recommended for new sites.
The 2.x branch for Drupal 9 is no longer actively supported and not recommended for new sites.

If you are still using the 1.x or 2.x branch on your site, please create an issue on Github to let us know.

Requirements for installing LocalGov Drupal locally

To install locally, you will need Composer and we recommend Lando.

https://getcomposer.org/

https://lando.dev/

See the Lando requirements section for details of Docker requirements.

https://docs.lando.dev/basics/installation.html#system-requirements

Installing LocalGov Drupal locally

To install LocalGov Drupal locally for testing or development, use the Composer-based project template.

Change MY_PROJECT to whatever you'd like your project directory to be called.

composer create-project --stability stable localgovdrupal/localgov-project MY_PROJECT

Change directory into the MY_PROJECT directory and run lando start.

cd MY_PROJECT
lando start

Once lando has finished building, run the site installer.

lando drush si localgov -y

If you run into memory limit errors when running Composer commands, prefix the commands with COMPOSER_MEMORY_LIMIT=-1. For example, to install the project run:

COMPOSER_MEMORY_LIMIT=-1 composer create-project --stability stable localgovdrupal/localgov-project MY_PROJECT

Drupal 10

Drupal 10 is supported on the 3.x branch.

For new projects, we recommend using the composer project template with:

composer create-project localgovdrupal/localgov-project MY_PROJECT

Upgrading from Drupal 9 to Drupal 10

There are some significant changes to localgov_geo module that will need attention if you have geolocation entities in Drupal 9.

We have moved from using a localgov_geo entity to geo entity provide by https://www.drupal.org/project/geo_entity

Please read the localgov_geo 2.0.0 release notes on GutHub.

Also see more guidence on upgrading LocalGov Drupal from Drupal 9 to Drupal 10 at https://github.com/localgovdrupal/localgov/wiki/Upgrading-from-Drupal-9-...

Contributing

See CONTRIBUTING.md for current contribution guidelines.

Issue tracking

In the early development stages, most issues will be tracked in the github repository https://github.com/localgovdrupal/localgov/issues.

Development issues relating to specific projects or module should be tracked in the project repository. In the future we might set up a separate repository for centralised issue tracking of bug reports for end users.