PHPackages thinkshout/bene-project - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. thinkshout/bene-project ActiveProject[Utility & Helpers](/categories/utility) thinkshout/bene-project ======================= ThinkShout's project template for Drupal 8 projects with composer 11.2k[36 issues](https://github.com/thinkshout/bene-project/issues)[2 PRs](https://github.com/thinkshout/bene-project/pulls)PHP Since Sep 8Pushed 6y ago2 watchersCompare [ Source](https://github.com/thinkshout/bene-project)[ Packagist](https://packagist.org/packages/thinkshout/bene-project)[ RSS](/packages/thinkshout-bene-project/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependenciesVersions (15)Used By (0) [![CircleCI](https://camo.githubusercontent.com/55f54042bf9a3064da4afaeb578b3eef314a4fb31764b494fc062765a103a0f5/68747470733a2f2f636972636c6563692e636f6d2f67682f7468696e6b73686f75742f62656e652d70726f6a6563742f747265652f6d61737465722e7376673f7374796c653d737667)](https://circleci.com/gh/thinkshout/bene-project/tree/master) Bene Project ============ [](#bene-project) New Projects ------------ [](#new-projects) ### Create a Git Repository [](#create-a-git-repository) Go to github and create a new repository. The script expects an empty repository. Do not put anything in it or the script will fail. ### Continuous Integration [](#continuous-integration) See the instructions at `.circleci/README.md` to configure CircleCI. ### Initial Build [](#initial-build) Create a local project (change 'my-bene-project' to the name of your project): `composer create-project thinkshout/bene-project --stability dev --no-interaction ~/Sites/my-bene-project` Create an empty database in your environment to install into: `mysql -uroot -p -e "create database benesite"` CD into the `~/Sites/my-bene-project` directory, and build your site into your new directory with this command: `./scripts/install.sh` There are several prompts along the way with a few things to keep in mind: - A prompt will ask for the database name later in the process. If the database does not exist, the script will fail. Use the database created above, but be aware that if you choose an existing one, the contents will be cleared out by the script. **Done! Your output script should verify with a message similar to:** `Finished installing Bene.` Change directory into ~/Sites/bene-new-project and run ``` drush uli ``` Existing projects ----------------- [](#existing-projects) ### Initial build (existing repo) [](#initial-build-existing-repo) From within your ~/Sites directory run: ``` git clone git@github.com:thinkshout/new-project-name.git cd new-project-name composer install ``` ### Testing [](#testing) Test are run automatically on CircleCI, but can be run locally as well with: ``` robo test ``` Updating the code ----------------- [](#updating-the-code) ### Updating the install profile [](#updating-the-install-profile) All work on the profile should occur in `web/profiles/bene`. Commit and push changes to that repo. To update the profile within your project run `robo dev:update` from your project ### Updating contrib modules [](#updating-contrib-modules) With `composer require drupal/{module_name}` you can download new dependencies to your installation. ``` composer require drupal/devel:8.* ``` ### Applying patches to contrib modules [](#applying-patches-to-contrib-modules) If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the [composer-patches](https://github.com/cweagans/composer-patches) plugin. To add a patch to drupal module "foobar" insert the patches section in the `extra`section of composer.json: ``` "extra": { "patches": { "drupal/foobar": { "Patch description": "URL to patch" } } } ``` ### Updating Drupal Core [](#updating-drupal-core) This project will attempt to keep all of your Drupal Core files up-to-date; the project [drupal-composer/drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold)is used to ensure that your scaffold files are updated every time drupal/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modfied files are updated in a new release of Drupal core. Follow the steps below to update your core files. 1. Run `composer update drupal/core --with-dependencies` to update Drupal Core and its dependencies. 2. Run `git diff` to determine if any of the scaffolding files have changed. Review the files for any changes and restore any customizations to `.htaccess` or `robots.txt`. 3. Commit everything all together in a single commit, so `web` will remain in sync with the `core` when checking out branches or running `git bisect`. 4. In the event that there are non-trivial conflicts in step 2, you may wish to perform these steps on a branch, and use `git merge` to combine the updated core files with your customized files. This facilitates the use of a [three-way merge tool such as kdiff3](http://www.gitshah.com/2010/12/how-to-setup-kdiff-as-diff-tool-for-git.html). This setup is not necessary if your changes are simple; keeping all of your modifications at the beginning or end of the file is a good strategy to keep merges easy. Notes ----- [](#notes) Development set-up ------------------ [](#development-set-up) This is a Drupal 8 site built using the [robo taskrunner](http://robo.li/). First you need to [install composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx). `brew install composer` Next add `./vendor/bin` to your PATH, at the beginning of your PATH variable, if it is not already there (only if not using a new Bene install) Check with: `echo $PATH` Update with: `export PATH=./vendor/bin:$PATH` You can also make this change permanent by editing your `~/.zshrc` or `~/.bashrc` file: `export PATH="./vendor/bin:...` ### Building (automatically done for new repo) [](#building-automatically-done-for-new-repo) Running the `robo configure` command will read the .env.dist, cli arguments and your local environment (`DEFAULT_PRESSFLOW_SETTINGS`) to generate a .env file. This file will be used to set the database and other standard configuration options. If no database name is provided, the project name and the git branch name will be used. If no profile name is provided, "standard" will be used. Note the argument to pass to robo configure can include: --db-pass; --db-user; --db-name; --db-host; --profile. ``` robo configure --profile=bene # Use an alternate DB password robo configure --profile=bene --db-pass= # Use an alternate DB name robo configure --profile=bene --db-name= ``` The structure of `DEFAULT_PRESSFLOW_SETTINGS` if you want to set it locally is (set by default for new repos): ``` DEFAULT_PRESSFLOW_SETTINGS_={"databases":{"default":{"default":{"driver":"mysql","prefix":"","database":"","username":"root","password":"root","host":"localhost","port":3306}}},"conf":{"pressflow_smart_start":true,"pantheon_binding":null,"pantheon_site_uuid":null,"pantheon_environment":"local","pantheon_tier":"local","pantheon_index_host":"localhost","pantheon_index_port":8983,"redis_client_host":"localhost","redis_client_port":6379,"redis_client_password":"","file_public_path":"sites\/default\/files","file_private_path":"sites\/default\/files\/private","file_directory_path":"site\/default\/files","file_temporary_path":"\/tmp","file_directory_temp":"\/tmp","css_gzip_compression":false,"js_gzip_compression":false,"page_compression":false},"hash_salt":"","config_directory_name":"sites\/default\/config","drupal_hash_salt":""} ``` ### Installing (automatically done for new repo) [](#installing-automatically-done-for-new-repo) Running the robo install command will run composer install to add all required dependencies and then install the site and import the exported configuration. ``` robo install ``` ### Health Score 23 — LowBetter than 27% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity16 Limited adoption so far Community17 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/ef10144725b45b95afc4cf117771dd572060735666ddabe9034c29b0d7ff2fb2?d=identicon)[tauno](/maintainers/tauno) ![](https://www.gravatar.com/avatar/39c2a2cb0119d25bf47fee43624599e4d7c6665ea209f1803455a88ba1b3679f?d=identicon)[mortenson](/maintainers/mortenson) --- Top Contributors [![tauno](https://avatars.githubusercontent.com/u/250188?v=4)](https://github.com/tauno "tauno (22 commits)")[![unclegcb](https://avatars.githubusercontent.com/u/2730679?v=4)](https://github.com/unclegcb "unclegcb (20 commits)")[![mortenson](https://avatars.githubusercontent.com/u/2091002?v=4)](https://github.com/mortenson "mortenson (19 commits)")[![jshinrock](https://avatars.githubusercontent.com/u/662848?v=4)](https://github.com/jshinrock "jshinrock (13 commits)")[![mariacha](https://avatars.githubusercontent.com/u/999525?v=4)](https://github.com/mariacha "mariacha (13 commits)")[![rjacobsen0](https://avatars.githubusercontent.com/u/5161930?v=4)](https://github.com/rjacobsen0 "rjacobsen0 (9 commits)")[![ruscoe](https://avatars.githubusercontent.com/u/87952?v=4)](https://github.com/ruscoe "ruscoe (4 commits)")[![komejo](https://avatars.githubusercontent.com/u/1668324?v=4)](https://github.com/komejo "komejo (2 commits)")[![olivierbouwman](https://avatars.githubusercontent.com/u/7672249?v=4)](https://github.com/olivierbouwman "olivierbouwman (1 commits)")[![juliaford](https://avatars.githubusercontent.com/u/28023410?v=4)](https://github.com/juliaford "juliaford (1 commits)") ### Embed Badge ![Health badge](/badges/thinkshout-bene-project/health.svg) ``` [![Health](https://phpackages.com/badges/thinkshout-bene-project/health.svg)](https://phpackages.com/packages/thinkshout-bene-project) ``` ### Alternatives [workerman/globaldata 8164.2k16](/packages/workerman-globaldata)[silverstripe/html5 HTML5 support for SilverStripe 16232.6k4](/packages/silverstripe-html5)[thedmsgroup/mautic-contact-client-bundle Create custom integrations without writing code. 1004.0k](/packages/thedmsgroup-mautic-contact-client-bundle)[kunstmaan/utilities-bundle The KunstmaanUtilitiesBundle makes your life easier by providing a couple of small but usefull helper services you can use and re-use in your applications. We already implemented an easy to use cipher service and a shell helper service for you but feel free to send in a pull request with your additions. The shell helper allows you to run apps in the background, see if a process is running and has a method to kill a running process. The cipher service allow you to encode and decode strings using the Rijndael 256 cipher 13150.5k6](/packages/kunstmaan-utilities-bundle)[uestla/twigrid Experimental DataGrid for Nette Framework 1712.3k2](/packages/uestla-twigrid)[miladrahimi/php-enum A PHP Abstract Enum Class 1113.0k](/packages/miladrahimi-php-enum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)