District Core Developer DocsDistrict Core Developer Docs
Developers
Boilerplate
Modules
Bitbucket
Developers
Boilerplate
Modules
Bitbucket
  • App Boilerplate

    • Requirements
    • Developing
    • Projects

App boilerplate requirements

Requirements to develop on a project using the app boilerplate

All the tools required by District Core

See the developer docs for specifics, but things like docker and lando are essential

SSH Access to Core Repo

It is assumed that you have access to the core repo as you are reading this. It is also assumed that you have added your SSH key to your Bitbucket account.

Core repo access and using a ssh key other than ~/.ssh/id_rsa

It is assumed that your ssh key is found locally on your host at ~/.ssh/id_rsa which lando will mount in docker to /user/.ssh/id_rsa. If your key is named differently, you need to do a couple of extra steps before your first composer install.

Eg If your key is ~/.ssh/district_key (on your host) then you need to mount that where lando is expecting to find it. You can do this with a .lando.local.yml file added to the root of the project.

services:
  cli:
    overrides:
      volumes:
        - ~/.ssh/district_key:/user/.ssh/id_rsa

After adding this, do a lando rebuild. The .lando.local.yml file is in .gitignore and should not be committed.

Edit this page
Next
Developing