{"id":22245761,"url":"https://github.com/oddhill/drupal-starter-kit","last_synced_at":"2025-07-28T02:33:09.069Z","repository":{"id":47658305,"uuid":"76033941","full_name":"oddhill/drupal-starter-kit","owner":"oddhill","description":"Base for creating new Drupal sites.","archived":false,"fork":false,"pushed_at":"2023-11-03T12:55:09.000Z","size":135,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-08T08:26:29.024Z","etag":null,"topics":["composer","drupal","starter-kit"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oddhill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-12-09T12:33:22.000Z","updated_at":"2023-11-03T12:55:17.000Z","dependencies_parsed_at":"2023-10-20T16:46:36.101Z","dependency_job_id":"37bf022e-073d-49f1-9753-493c5674600b","html_url":"https://github.com/oddhill/drupal-starter-kit","commit_stats":{"total_commits":62,"total_committers":2,"mean_commits":31.0,"dds":"0.032258064516129004","last_synced_commit":"0bfb34b572e448915430dc60e523b5bb09e54e5a"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddhill%2Fdrupal-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddhill%2Fdrupal-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddhill%2Fdrupal-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddhill%2Fdrupal-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oddhill","download_url":"https://codeload.github.com/oddhill/drupal-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227857790,"owners_count":17830267,"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":["composer","drupal","starter-kit"],"created_at":"2024-12-03T05:18:25.358Z","updated_at":"2024-12-03T05:18:26.068Z","avatar_url":"https://github.com/oddhill.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Drupal 10 starter kit, by Odd Hill AB\n\nThis is a starter kit for creating new sites for Drupal with a composer\nbased workflow, this project is used at [Odd Hill](http://www.oddhill.se/)\nwhen creating new projects.\n\n## Notable features\n\n- Uses [vlucas/phpdotenv](vlucas/phpdotenv) to load local environment configuration.\n- Uses the recommended Drupal composer packages to scaffold the project.\n- Easy deployments through SSH with CircleCI.\n\n## Requirements\n\nThe requirements are basically the same as for Drupal 9 but will be set a bit\nhigher to allow us to take advantage of new language features and more. If you\nneed to use lower versions everything should work as long as it follows the\nDrupal [system requirements](https://www.drupal.org/docs/system-requirements).\nYou might have to make changes to the CircleCI configuration if you decide to\nuse other versions.\n\n- [Composer 2.0](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)\n- PHP 8.1\n- Apache\n- MySQL 5.7 or 8.0\n\n## Getting started\n\n### Create\n\nStart by making sure that you have met all the requirements for using the\nstarter kit. You can then run the following command to create a new project\nbased on this repository:\n\n```\ncomposer create-project oddhill/drupal-starter-kit ./project-dir --stability dev --no-interaction\n```\n\n### Prepare\n\n1. Copy settings.php located in the examples folder to the `public/sites/default`directory.\n2. Copy the `.env.default` file located in the project root and rename it to `.env`.\n3. Upate the environment variables in the `.env` file to match the settings for your local environment.\n\n### Install\n\nWhen loading the website for the first time you will get an error because\nDrupal has not been installed and the database is empty.\n\nTo install Drupal you will have to open the `example.localhost/core/install.php`\npage in a browser and then go through the installation process.\n\nYou now have a new Drupal site installed and configured to use environment\nvariables, our custom profile, basic deployment and more.\n\n## Adding a theme\n\nYou can use any theme with this starter kit but it's recommended to use our\nstarter theme [oddbady](https://github.com/oddhill/drupal-oddbaby) since it\nintegrates well with the CircleCI configuration.\n\n## Deployment\n\nDeployment is handled through CircleCI. The deployment script only supports\nLinux environments since rsync and SSH is used to perform the deployment.\nThe deployment also runs various steps that check coding standards in\ncustom modules and themes as well as build the theme for deployment.\n\nThe steps that handles the linting and building of the theme assumes that our\nstarter theme [oddbady](https://github.com/oddhill/drupal-oddbaby) is used.\n\nSince you will most likely be renaming the theme to fit the specific project\nthere is a parameter that can easily be changed at the top of the deployment\nconfiguration that will let you set the directory for the theme that should\nbe used.\n\n### First deployment\n\nThe first deployment will be a bit different since the site has not been set up\non the server already. The post deployment step will always fail because of\nthis and can be temporarily disabled before the first deployment is run and\nthen be enabled again after the site has been set up.\n\nSince the deployment is done through CircleCI the configuration file needs to\nbe updated before the first deployment is done. Make sure the correct path has\nbeen set for the theme and that the configuration for the deployment and post\ndeployment steps have been changed to match the server that the site should be\ndeployed to.\n\nYou will also need the setup the project in CircleCI and add a SSH key to the\nproject so that the server will allow the SSH connection. Read\n[adding an SSH key to CirclecI](https://circleci.com/docs/2.0/add-ssh-key/) if\nyou have not done this before.\n\nAfter the site has been deployed for the first time you will have to perform\nthe following steps to get the site up and running.\n\n1. Copy the `.env.default` file, rename it to `.env` and then edit it and set\n   the correct variables for the environment.\n2. Create a `.htaccess` file in the `public` folder and paste the contens from\n   your local copy of the `.htaccess` file. This is required since the file is\n   ignored by rsync during the deployment step.\n3. Create the `public/sites/default/files` directory and make sure that the\n   permissions for this folder is set to 775.\n4. Go to the site by visiting `example.domain/core/install.php` and you should\n   now see the installation page. After this is done the site is ready!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddhill%2Fdrupal-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foddhill%2Fdrupal-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddhill%2Fdrupal-starter-kit/lists"}