{"id":14968596,"url":"https://github.com/localgovdrupal/localgov","last_synced_at":"2025-05-16T09:03:14.926Z","repository":{"id":37083867,"uuid":"261134819","full_name":"localgovdrupal/localgov","owner":"localgovdrupal","description":"Installation profile for the LocalGov Drupal distribution.","archived":false,"fork":false,"pushed_at":"2025-05-13T10:43:10.000Z","size":14958,"stargazers_count":89,"open_issues_count":176,"forks_count":19,"subscribers_count":17,"default_branch":"3.x","last_synced_at":"2025-05-13T11:37:52.545Z","etag":null,"topics":["drupal","localgov","localgovdrupal"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/localgovdrupal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-04T09:45:03.000Z","updated_at":"2025-05-13T10:42:38.000Z","dependencies_parsed_at":"2023-11-09T11:54:24.587Z","dependency_job_id":"c26dee11-86ca-4f38-b278-51c2a7a06f9c","html_url":"https://github.com/localgovdrupal/localgov","commit_stats":{"total_commits":264,"total_committers":24,"mean_commits":11.0,"dds":0.625,"last_synced_commit":"4e6d5612d07cd3a39f6fec94880b303aef0eb3d2"},"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Flocalgov","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Flocalgov/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Flocalgov/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Flocalgov/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localgovdrupal","download_url":"https://codeload.github.com/localgovdrupal/localgov/tar.gz/refs/heads/3.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254501555,"owners_count":22081528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["drupal","localgov","localgovdrupal"],"created_at":"2024-09-24T13:40:16.347Z","updated_at":"2025-05-16T09:03:14.905Z","avatar_url":"https://github.com/localgovdrupal.png","language":"PHP","readme":"# LocalGov Drupal\n\nA Drupal distribution and installation profile designed to help UK and Irish councils collaborate and\nshare Drupal code and build a culture of publishing excellent website content for everyone.\n\nThis project is the Drupal installation profile that is best installed using\ncomposer to require a project template, [localgov_project]([url](https://github.com/localgovdrupal/localgov_project/)), to scaffold and build\nthe codebase, which includes this installation profile.\n\n## Patches\n\nPlease note, if you are using Drupal core \u003c 10.3.6, you might want to apply\nthis patch for content moderation and workspaces.\n\n - [Patch](https://www.drupal.org/files/issues/2024-08-11/3179199-3132022-content-moderation-workspaces-query.patch)\n - [Issue](https://www.drupal.org/project/drupal/issues/3179199#comment-15711680)\n\n## Supported branches\n\nWe are actively developing and supporting the 3.x branch for Drupal 10.\n\nThe 2.x branch is no longer officially supported, as Drupal 9 is unsupported since 1st November 2023.\nWe will continue to help our councils that have not yet upgraded to Drupal 10, on a best efforts basis.\n\nThe 1.x branch is no longer actively supported and not recommended for new sites.\n\n**Important:** If you are still using the 1.x or 2.x branches on your site, please [create an issue on Github](https://github.com/localgovdrupal/localgov/issues) to let us know.\n\n## Documentation\n\nFurther documentation for developers, content designers and other audiences can\nbe found at [https://docs.localgovdrupal.org/](https://docs.localgovdrupal.org/).\n\n## Requirements for installing LocalGov Drupal locally for testing and development\n\nTo install LocalGov Drupal locally you will need an appropriate versions of:\n\n - PHP (see https://www.drupal.org/docs/system-requirements/php-requirements)\n - A database server like MySQL (see https://www.drupal.org/docs/system-requirements/database-server-requirements)\n - A web server like Apache2 (see https://www.drupal.org/docs/system-requirements/web-server-requirements)\n\nMany of us use the Lando file included to run a local docker environmnent for testing and development, but some people prefer to run the web servers natively on their host machine.\n\nWe also include default DDEV configuration for developers that prefer DDEV. [Visit our DDEV docs page](https://docs.localgovdrupal.org/devs/getting-started/working-with-ddev.html#working-with-ddev) to see how to get set up.\n\n### PHP requirements\n\nWe folllow Drupal's PHP recomendations: https://www.drupal.org/docs/system-requirements/php-requirements#versions\n\nWe currently recomend PHP 8.1 also aim to support PHP PHP 8.2 in line with Drupal 10's PHP support.\n\nYou will also need to have certain PHP extensions enabled (see https://www.drupal.org/docs/system-requirements/php-requirements#extensions) including:\n\n - PHP mbstring\n - PHP cURL\n - GD library\n - XML\n\nIf you see errors when running composer require, double check your PHP extensions.\n\n## Composer and Lando\n\nTo install locally, you will need Composer and we recommend using Lando for a consistent developer environment.\n\n - https://getcomposer.org/\n - https://lando.dev/\n\nPlease also see the Lando requirements section for details of Docker\nrequirements for different operating systems.\n\nhttps://docs.lando.dev/basics/installation.html#system-requirements\n\n## Installing LocalGov Drupal locally with composer\n\nTo install LocalGov Drupal locally for testing or development, use the\n[Composer-based project template](https://github.com/localgovdrupal/localgov_project).\n\nChange `MY_PROJECT` to whatever you'd like your project directory to be called.\n\n```bash\ncomposer create-project localgovdrupal/localgov-project:^3.0 MY_PROJECT --no-install\n```\n\nChange directory into the MY_PROJECT directory and run lando start.\n\n```bash\ncd MY_PROJECT\nlando start\n```\n\nOnce lando has finished building, use lando to run composer install and the site installer.\n\n```bash\nlando composer install\nlando drush si localgov -y\n```\n\nNote: As you might be running a different version of PHP on your host machine from the\nversion that Lando runs, it is advisable to run composer install from within Lando.\nThis ensures dependencies reflect the PHP version that the webserver is actually running.\n\n## Composer notes\n\nIf developing locally and you want to force composer to clone again\nfrom source rather than use composer cache, you can add the `--no-cache` flag.\n\n```bash\ncomposer create-project localgovdrupal/localgov-project:^3.0 MY_PROJECT --no-cache  --no-install\n```\n\nIf you just want to pull in the latest changes to LocalGov Drupal run composer\nupdate with the `--no-cache` flag.\n\n```bash\nlando composer update --no-cache\n```\n\nIf you want to be sure you are getting the latest commits when developing,\nclearing composer cache, deleting the folders and re-running composer update\nseems to be a solid approach:\n\n```bash\n\nrm -rf web/profiles/contrib/ web/modules/contrib/ web/themes/contrib/;\ncomposer clear-cache; composer update --with-dependencies --no-cache;\nlando start;\nlando drush si localgov -y;\n\n```\n\nIf you run into [memory limit errors](https://getcomposer.org/doc/articles/troubleshooting.md#memory-limit-errors)\nwhen running Composer commands, prefix the commands with `COMPOSER_MEMORY_LIMIT=-1`.\nFor example, to install the project run:\n\n```bash\nCOMPOSER_MEMORY_LIMIT=-1 composer create-project localgovdrupal/localgov-project:^3.0 MY_PROJECT\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for current contribution guidelines.\n\n## Issue tracking\n\nIn the early development stages, most issues will be tracked in this repository\n\u003chttps://github.com/localgovdrupal/localgov/issues\u003e.\n\nDevelopment issues relating to specific projects or module should be tracked in\nthe project repository. In the future we might set up a separate repository for\ncentralised issue tracking of bug reports for end users.\n\n## Development setup\n\nThe main development environment in use is currently\n[Lando](https://docs.lando.dev/) – a Docker based development environment that\nworks on Linux, MacOS and Windows.\n\n@todo Document Lando setup.\n\n## Coding standards\n\nPHP CodeSniffer is installed as a dev dependency by Composer and configured to\nuse Drupal coding standards and best practices. It is a good idea to run these\nbefore committing any code. All code in pull requests should pass all\nCodeSniffer tests.\n\nTo check code using Lando run:\n\n```bash\nlando phpcs\n```\n\nTo attempt to automatically fix coding errors in Lando run:\n\n```bash\nlando phix\n```\n\n### Coding standards resources\n\n* [Drupal coding standards](https://www.drupal.org/docs/develop/standards)\n\n## Running tests\n\nThe included `phpunit.xml.dist` file contains configuration for automatically\nrunning the LocalGov Drupal test suite.\n\nTo run all LocalGov Drupal tests with Lando use:\n\n```bash\nlando phpunit\n```\n\nTo run all the tests for a specific module use:\n\n```bash\nlando phpunit web/modules/contrib/localgov_my_module\n```\n\nTests can be filtered using the `--filter` option. To only run a specific test\nuse:\n\n```bash\nlando phpunit --filter=myTestName\n```\n\n### Testing resources\n\n* [PHPUnit documentation](https://phpunit.readthedocs.io/en/7.5/)\n* [Drupal 8 PHPUnit documentation](https://www.drupal.org/docs/8/testing/phpunit-in-drupal-8)\n* [Drupal 8 testing documentation](https://www.drupal.org/docs/8/testing)\n* [Workshop: Automated Testing and Test Driven Development in Drupal 8](https://github.com/opdavies/workshop-drupal-automated-testing)\n\n## Security policy\n\nIt is important to have a way to report security issues safely and securely. Luckily this is something Drupal has done very well for many years, via the security team. We publish our distributions on drupal.org and opt in to the [security advisory policy](https://www.drupal.org/security-advisory-policy)..\n\nSee https://www.drupal.org/drupal-security-team/general-information\n\n### How to report a security issue\n\nIf you discover or learn about a potential error, weakness, or threat that can compromise the security of Drupal, LocalGov Drupal or LocalGov Drupal Microsites, we ask you to keep it confidential and [submit your concern to the Drupal security team](http://drupal.org/node/101494).\n\n## Maintainers\n\nThis project is currently maintained by:\n\n - Andy Broomfield: https://www.drupal.org/u/andybroomfield\n - Ekes: https://www.drupal.org/u/ekes\n - Finn Lewis: https://www.drupal.org/u/finn-lewis\n - Maria Young: https://www.drupal.org/u/mariay-0\n - Mark Conroy: https://www.drupal.org/u/markconroy\n - Stephen Cox: https://www.drupal.org/u/stephen-cox\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalgovdrupal%2Flocalgov","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalgovdrupal%2Flocalgov","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalgovdrupal%2Flocalgov/lists"}