Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LastCallMedia/Drupal-Scaffold
DEPRECATED: This project has been replaced by documentation within Confluence regarding best practices for setting up a new Drupal 9 project.
https://github.com/LastCallMedia/Drupal-Scaffold
archived deprecated
Last synced: about 2 months ago
JSON representation
DEPRECATED: This project has been replaced by documentation within Confluence regarding best practices for setting up a new Drupal 9 project.
- Host: GitHub
- URL: https://github.com/LastCallMedia/Drupal-Scaffold
- Owner: LastCallMedia
- License: gpl-2.0
- Created: 2016-08-13T16:34:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T10:41:14.000Z (7 months ago)
- Last Synced: 2024-08-05T22:39:22.805Z (5 months ago)
- Topics: archived, deprecated
- Language: PHP
- Homepage:
- Size: 1.56 MB
- Stars: 46
- Watchers: 9
- Forks: 19
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
LCM Drupal 8 Scaffolding
========================
[](https://circleci.com/gh/LastCallMedia/Drupal-Scaffold)
[](https://packagist.org/packages/lastcall/drupal-scaffold)
LCM Drupal 8 Scaffolding is brought to you by your friends at [Last Call Media](https://www.lastcallmedia.com), it is a boilerplate Drupal 8 build that bundles some standard tools to make it a good starting point for an enterprise scale Drupal build. It is conceptually similar to [drupal-composer/drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold), but it has a much simpler (and more manual) Composer setup, and includes additional tools. For additional information on this project, see the [2016 Badcamp presentation slides](https://2016.badcamp.net/sites/default/files/session-files/FirstClassDevelopmentWorkflow.pdf)
Starting a New Project
----------------------
- [ ] Use composer to create a new project, starting from this repository as a template:
```bash
composer create-project lastcall/drupal-scaffold PROJECTNAME
```
- [ ] Bring up the Docker containers and enter the Drupal container.
```bash
docker-compose up -d drupal
docker-compose exec drupal /bin/bash
```
- [ ] From the repository root (`/var/www` inside the Drupal container), install NPM and composer dependencies:
```bash
yarn install
composer install
```
- [ ] Visit the Drupal site in your browser to install Drupal and continue. The default URL will be `http://localhost:8080`.
See the [scaffold documentation](docs/scaffold.md) for next steps.
## Stop here!
Everything below this line applies to scaffold projects that are already set up. The section below will be the start of your project's README.
---------------------------------------------
Setting Up for Local Development
--------------------------------
This project is built using Drupal Scaffold. Before you begin, you must have Docker and Docker Compose installed on your local machine. For installation instructions, see the [Drupal Scaffold - Docker documentation](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/tools/docker.md).
1. [Clone](https://help.github.com/articles/cloning-a-repository/) this repository.
2. If you haven't created and [set your Pantheon machine token](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/recipes/setting-machine-token.md), do that now.
3. [Start](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/tools/docker.md#Running) the Docker environment and shell in:
```bash
docker-compose up -d drupal
docker-compose exec drupal bash
```
3. Install [Composer](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/tools/composer.md#Running) dependencies:
```bash
composer install
```
4. Install [NPM](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/tools/npm.md#Running) dependencies:
```bash
yarn install
```
5. Run `composer site:import` to pull down and import a copy of the site's database. If Pantheon gives you an error here, make sure you followed Step 2 above correctly and that you're running Docker in a new terminal window
6. Run `drupal site:mode dev` to switch to dev configuration.
7. Run `gulp build` (or `gulp watch`) and `drush cr` (from within the Drupal root at `/var/www/web`) to compile the theme.
8. View your new local site in the browser at [http://localhost:8080/](http://localhost:8080/).
See the [Drupal Scaffold documentation](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/) for more information on how to use the tools and how to use this project. To find more information on the Docker stack, visit the [Docker documenation](https://github.com/LastCallMedia/Drupal-Scaffold/blob/master/docs/tools/docker.md).
Testing
--------
Both testing tools listed below are using the following JSON files for switching the environments and fetching the URLs for these testing tools. If any changes are needed make changes to the files below:
- [Environments JSON](/backstop/environment.json)
- [URLs JSON](/backstop/page.json)
The option to switch environments can be used by adding the following to command `--target=prod`. It will always default to local if no target is being used.
### Nightcrawler
Nightcrawler will run in CircleCI for each Pull Request, but if you want to test the PR locally use the following command
```
$ docker-compose run drupal node_modules/.bin/nightcrawler crawl
```
### Backstop
Backstop is only tested manually, see [documentation](/backstop/README.md) to test your branch.