github.com/ddev/ddev@v1.23.2-0.20240519125000-d824ffe36ff3/README.md (about)

     1  <picture>
     2    <source media="(prefers-color-scheme: dark)" srcset="https://ddev.com/logos/dark-ddev.svg">
     3    <img alt="DDEV logo with light and dark mode variants" src="https://ddev.com/logos/ddev.svg">
     4  </picture>
     5  
     6  ---
     7  
     8  [![CircleCI](https://circleci.com/gh/ddev/ddev.svg?style=shield)](https://circleci.com/gh/ddev/ddev) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
     9  [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ddev/ddev) <a href="https://codespaces.new/ddev/ddev"><img src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces" style="max-width: 100%; height: 20px;"></a>
    10  
    11  DDEV is an open-source tool for running local web development environments for PHP, Python and Node.js, ready in minutes. Its powerful, flexible per-project environment configurations can be extended, version controlled, and shared. DDEV allows development teams to adopt a consistent Docker workflow without the complexities of bespoke configuration.
    12  
    13  ## Documentation
    14  
    15  To check out live examples, docs, contributor live training, guides and more visit [ddev.com](https://ddev.com) and [ddev.readthedocs.io](https://ddev.readthedocs.io/en/stable/users/support)
    16  
    17  ## Questions
    18  
    19  If you need help, our friendly community provides [great support](https://ddev.readthedocs.io/en/stable/users/support/).
    20  
    21  ## Wonderful Sponsors
    22  
    23  DDEV is an Apache License 2.0 open-source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [sponsoring DDEV development](https://github.com/sponsors/ddev).
    24  
    25  <picture>
    26    <source media="(prefers-color-scheme: dark)" srcset="https://ddev.com/resources/featured-sponsors-darkmode.svg">
    27    <img alt="DDEV Sponsor logos with light and dark mode variants" src="https://ddev.com/resources/featured-sponsors.svg">
    28  </picture>
    29  
    30  ## Contributing
    31  
    32  See “How can I contribute to DDEV?” in the [FAQ](https://ddev.readthedocs.io/en/stable/users/usage/faq/), and the [Contributing](CONTRIBUTING.md) page.
    33  
    34  ![Overview of GitHub contributions](https://repobeats.axiom.co/api/embed/941b040a17921e974655fc01d7735aa350a53603.svg "Repobeats analytics image")
    35  
    36  ## Get Started
    37  
    38  1. **Check [System Requirements](https://ddev.readthedocs.io/):** macOS (Intel and Apple Silicon), Windows 10/11, WSL2, Linux, [Gitpod](https://www.gitpod.io), and [GitHub Codespaces](https://github.com/codespaces).
    39  2. **Install a [Docker provider and DDEV](https://ddev.readthedocs.io/en/stable/users/install/)**.
    40  3. **Try a [CMS Quick Start Guide](https://ddev.readthedocs.io/en/stable/users/quickstart/)**.
    41  
    42  Additionally, [https://ddev.com/get-started/](https://ddev.com/get-started/) provides an up-to-date getting-started guide.
    43  
    44  ## Highlighted Features
    45  
    46  * Quickly create local web development environments based on code repositories, with minimal configuration.
    47  * Import a database to any of your local environments.
    48  * Import upload files to match the project (e.g. Drupal sites/default/files or WordPress `wp-content/uploads`).
    49  * Customizable integration with hosting platforms like [Platform.sh](https://platform.sh), [Pantheon](https://pantheon.io), [Acquia](https://www.acquia.com) and others.
    50  * Run commands within the Docker environment using `ddev exec`.
    51  * View logs from the web and database containers.
    52  * Use `ddev ssh` to explore the Linux environment inside the container.
    53  * List running projects with `ddev list`.
    54  * Snapshot databases with `ddev snapshot`.
    55  * Temporarily share your development website with others using `ddev share`.
    56  * Create custom commands as simple shell scripts.
    57  * Enjoy effortless, trusted HTTPS support.
    58  * Extend and customize environments as much (or as little!) as you need to.
    59  
    60  Run `ddev` to see all the [commands](https://ddev.readthedocs.io/en/stable/users/usage/cli/).