Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 2.96 KB

README.dist.md

File metadata and controls

86 lines (58 loc) · 2.96 KB

{ Your Project Name }

This is the development repository for { your project's } Drupal website. It contains the codebase and an environment to run the site for development.

Table of Contents

Development Environment

This project uses ddev for its development environment. To run the environment, you will need:

Docker and DDev can be installed with homebrew:

brew install docker --cask
brew install ddev

Getting Started

  1. Clone the project from github: git clone https://github.com/palantirnet/your-project.git
  2. From inside the project root, run:
  composer install
  ddev start
  1. Install the Drupal site: vendor/bin/phing install (this can be run inside or outside of ddev)
  2. Visit your site at your-project.ddev.site

Drupal Development

You can refresh/reset your local Drupal site at any time. SSH into your ddev environment and then:

  1. Download the most current dependencies: composer install
  2. Rebuild your local CSS and Drupal settings file: phing build
  3. Reinstall Drupal: phing install (this will run build implicitly)
  4. Run your migrations: phing migrate
  5. ... OR run all three phing targets at once: phing install migrate (again, install runs build for you)
  • Shared development environment settings are committed to git in docroot/sites/default/settings.ddev-overrides.php
  • To customize local development settings, copy:
    • docroot/sites/default/default.settings.local.php to settings.local.php
    • docroot/sites/default/default.services.local.yml to services.local.yml
  • Config is exported to the config/ directory; config_split module is used to manage environment-specific config
  • The artifacts/ directory can be used to store files and database dumps that should not be checked in to git

Additional information on developing for Drupal within this environment is in docs/general/drupal_development.md.

Styleguide Development

@todo This section needs to be customized per-project.

  • cd styleguide on your host machine
  • yarn install
  • yarn serve
  • control+c to stop

For additional documentation, refer to styleguide/README.md and styleguide/docs/*.

Deployment

@todo This section needs to be customized per-project.

Additional Documentation

Project-specific:

General:

Copyright 2022 Palantir.net, Inc.