Merge pull request #269 from dur41d/master

Added instructions for setting up local dev with ddev

Author: rijkvanzanten

.vuepress/config.js

@@ -164,6 +164,7 @@ module.exports = {
         children: [
           ['/advanced/other-install-methods', 'Other Install Methods'],
           ['/advanced/source', 'Local Dev Environment'],
+          ['/advanced/ddev', 'Local Dev Environment with DDEV'],
           ['/advanced/server-setup', 'Server Setup'],
           ['/advanced/api/configuration', 'API Configuration'],
           ['/advanced/api/data', 'Direct Data Access']

advanced/ddev.md

@@ -0,0 +1,58 @@
+# Setup Development Environment using DDEV
+
+[DDEV](https://ddev.readthedocs.io/en/stable/) allows running the API on your machine using docker which saves you from installing and configuring the dependencies.
+
+## API
+
+* Install DDEV on your machine by following the [installation instructions](https://ddev.readthedocs.io/en/stable/#installation) of your operating system.
+* Clone the api repo.
+```bash
+git clone https://github.com/directus/api.git
+OR
+git clone [email protected]:directus/api.git
+```
+* Run ddev config in the API folder and set the `Docroot` to `public` and project type to `php`.
+```bash
+ddev config
+```
+
+* Install composer dependencies.
+```bash
+ddev exec composer install
+```
+* Start ddev.
+```bash
+ddev start
+```
+* Run the following command in order to get the service and tools details, like `phpmyadmin` and database connection.
+```bash
+ddev describe
+```
+
+
+## App
+
+* Clone the app repo.
+```bash
+git clone https://github.com/directus/app.git
+OR
+git clone [email protected]:directus/app.git
+```
+* Set the API_URL environment variable to point at the local ddev service URL and start the project.
+```bash
+set API_URL=http://<ddev-project>.ddev.site/
+```
+```bash
+npm run dev
+```
+* You'll be prompted to create a new project. Use the following database connection. database=db, port=3306, user=db, password=db.
+
+That's it. You will login to a freshly created Directus project. 
+
+**Tip**: ddev allows [PHP Step Debugging](https://ddev.readthedocs.io/en/stable/users/step-debugging/). You can enable it temporarily to avoid performance problems. 
+
+```bash
+ddev exec enable_xdebug 
+OR 
+ddev exec disable_xdebug
+```